itty-sockets 0.0.0

package/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: kwhitley
+open_collective: kevinrwhitley
+# patreon: # Replace with a single Patreon username
+# ko_fi: # Replace with a single Ko-fi username
+# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+# liberapay: # Replace with a single Liberapay username
+# issuehunt: # Replace with a single IssueHunt username
+# otechie: # Replace with a single Otechie username
+# custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

package/.github/workflows/coverage.yml

@@ -0,0 +1,19 @@
+on: ['push', 'pull_request_target']
+
+name: Test Coveralls
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: oven-sh/setup-bun@v2.0.1
+      - name: install, make test-coverage
+        run: |
+          bun install
+          bun test --coverage
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/lint.yml

@@ -0,0 +1,18 @@
+name: lint
+
+on:
+  push:
+    branches: [v1.x]
+  pull_request:
+    branches: [v1.x]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: oven-sh/setup-bun@v2.0.1
+      - name: Install dependencies
+      - run: bun install
+      - run: bun run lint

package/.github/workflows/release.yml

@@ -0,0 +1,29 @@
+name: Create Release
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v2
+
+    - name: Prepare tag for release notes
+      id: prep
+      run: echo "::set-output name=tag::$(echo ${GITHUB_REF#refs/tags/} | sed 's/\.//g')"
+
+    - name: Create Release
+      uses: actions/create-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tag_name: ${{ github.ref }}
+        release_name: Release ${{ github.ref }}
+        body: |
+          See [${{ github.ref_name }} CHANGELOG entry](https://github.com/kwhitley/itty-chroma/blob/v0.x/CHANGELOG.md#${{ steps.prep.outputs.tag }}) for notes
+        draft: false
+        prerelease: false

package/.github/workflows/verify.yml

@@ -0,0 +1,18 @@
+name: build
+
+on:
+  push:
+    branches: [v0.x]
+  pull_request:
+    branches: [v0.x] 
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: oven-sh/setup-bun@v2.0.1
+      - name: Install dependencies
+      - run: bun install
+      - run: bun run verify

package/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "useTabs": false,
+  "singleQuote": true,
+  "semi": false,
+  "trailingComma": "all",
+  "printWidth": 100
+}

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+## Changelog
+
+#### v1.0.0 
+- initial public release, considered stable
+#### v0.1.18
+- final pre-release
+#### v0.1.17
+- semifinal README
+#### v0.1.16
+- updates to README
+#### v0.1.15
+- mic check... check, check
+#### v0.1.x
+- test release
+

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+krwhitley@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

package/CONTRIBUTING.md

@@ -0,0 +1,92 @@
+# Contributing to Itty
+
+The [Open Source Guides](https://opensource.guide/) website has a collection of resources for individuals, communities, and companies. These resources help people who want to learn how to run and contribute to open source projects. Contributors and people new to open source alike will find the following guides especially useful:
+
+- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
+- [Building Welcoming Communities](https://opensource.guide/building-community/)
+
+## Bugs
+
+We use [GitHub issues](https://github.com/kwhitley/itty-router/issues) for our public bugs. If you would like to report a problem, take a look around and see if someone already opened an issue about it. If you are certain this is a new unreported bug, you can submit a [bug report](#reporting-new-issues).
+
+If you have questions about using itty, [contact us on Discord](https://discord.com/channels/832353585802903572), and we will do our best to answer your questions.
+
+### Reporting new issues
+
+When [opening a new issue](https://github.com/kwhitley/itty-router/issues/new/choose), always make sure to fill out the issue template. **This step is very important!** Not doing so may result in your issue not being managed in a timely fashion. Don't take this personally if this happens, and feel free to open a new issue once you've gathered all the information required by the template.
+
+- **One issue, one bug:** Please report a single bug per issue.
+- **Provide reproduction steps:** List all the steps necessary to reproduce the issue. The person reading your bug report should be able to follow these steps to reproduce your issue with minimal effort.
+
+### Proposing a change
+
+If you would like to request a new feature or enhancement but are not yet thinking about opening a pull request, you can also file an issue with [feature template](https://github.com/kwhitley/itty-router/issues/new?template=feature_request.yml).
+
+If you're only fixing a bug, it's fine to submit a pull request right away, but we still recommend that you file an issue detailing what you're fixing. This is helpful in case we don't accept that specific fix but want to keep track of the issue.
+
+Small pull requests are much easier to review and more likely to get merged.
+
+### Installation
+
+1. Ensure you have [npm](https://www.npmjs.com/get-npm) installed.
+1. Ensure you have [yarn](https://classic.yarnpkg.com/lang/en/docs/install) installed.
+1. After cloning the repository, run `yarn` in the root of the repository.
+1. To start development, run `yarn dev`.
+
+### Creating a branch
+
+Fork [the repository](https://github.com/kwhitley/itty-router) and create your branch from `v4.x`. If you've never sent a GitHub pull request before, you can learn how from [this free video series](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
+
+### Testing
+
+A good test plan has the exact commands you ran and their output, provides screenshots or videos if the pull request changes UI.
+
+- If you've changed APIs, update the documentation, including at the appropriate places within [itty.dev](https://itty.dev/itty-router).
+
+#### Writing tests
+
+All tests are located in adjacent `.spec.ts` files, next to the file being tested.
+
+#### Running tests
+
+1. To run test, run `yarn test`, or `yarn dev` for continuous testing (includes `--watch`).
+
+### Style guide
+
+[Eslint](https://eslint.org) will catch most styling issues that may exist in your code. You can check the status of your code styling by simply running `yarn lint`.
+
+#### Code conventions
+
+- `camelCase` for public variable names and methods.
+- No abbreviated variable names - maximize readability and let the minification process do its thing later.
+
+### Sending your pull request
+
+Please make sure the following is done when submitting a pull request:
+
+1. Describe your **test plan** in your pull request description. Make sure to test your changes.
+1. Make sure your code lints (`yarn lint`).
+1. Make sure your tests pass (`yarn test`).
+
+All pull requests should be opened against the `v4.x` branch. Make sure the PR does only one thing, otherwise please split it.
+
+#### Breaking changes
+
+When adding a new breaking change, follow this template in your pull request:
+
+```md
+### New breaking change here
+
+- **Who does this affect**:
+- **How to migrate**:
+- **Why make this breaking change**:
+- **Severity (number of people affected x effort)**:
+```
+
+## License
+
+By contributing to itty, you agree that your contributions will be licensed under its [MIT license](https://github.com/kwhitley/itty-router/blob/master/LICENSE).
+
+## Questions
+
+Feel free to ask in [#itty-router](https://discord.com/channels/832353585802903572) on [Discord](https://discord.com/channels/832353585802903572) if you have questions about our process, how to proceed, etc.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Kevin R. Whitley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,117 @@
+<br />
+
+<p>
+<a href="https://itty.dev/itty-sockets" target="_blank">
+  <img src="https://github.com/user-attachments/assets/cfe915d5-63ce-4297-83ef-316426c7af57" alt="itty-sockets" height="120" />
+</a>
+</p>
+
+[![Version](https://img.shields.io/npm/v/itty-sockets.svg?style=flat-square)](https://npmjs.com/package/itty-sockets)
+[![Bundle Size](https://deno.bundlejs.com/?q=itty-sockets&badge&badge-style=flat-square)](https://deno.bundlejs.com/?q=itty-sockets)
+[![Coverage Status](https://img.shields.io/coveralls/github/kwhitley/itty-sockets?style=flat-square)](https://coveralls.io/github/kwhitley/itty-sockets)
+[![Issues](https://img.shields.io/github/issues/kwhitley/itty-sockets?style=flat-square)](https://github.com/kwhitley/itty-sockets/issues)
+[![Discord](https://img.shields.io/discord/832353585802903572?label=Discord&logo=Discord&style=flat-square&logoColor=fff)](https://discord.gg/53vyrZAu9u)
+
+### [Documentation](https://itty.dev/itty-sockets) &nbsp;| &nbsp; [Discord](https://discord.gg/53vyrZAu9u)
+
+---
+
+Tiny messaging client in under 400 bytes.  No backend needed.
+
+## Example
+```ts
+import { connect } from 'itty-sockets'
+
+// create a channel instance
+const foo = connect('foo')
+
+// listen for messages
+foo.listen(e => {
+  console.log(e.alias ?? e.uid, 'says', e.message, 'at', e.date)
+})
+
+// send some messages
+room
+  .send('hello world!')
+  .send([1,2,3]) // no need to stringify
+  .send({ foo: 'bar' })
+
+// or connect, send, and close - all in one call
+room.push('this will send and close the connection')
+```
+
+## Features
+
+- Simple and powerful API for sending and receiving messages & data
+- Streamlines async race conditions
+- No backend service needed.  Ours is fast and stores/logs nothing at all
+- Ultra-tiny. It's an itty library, after all
+- Full TypeScript support (when imported)
+
+## What is itty-sockets?
+
+`itty-sockets` is a tiny messaging client that simplifies data/message transmission between users/connections.
+It's powered by [ittysockets.io](https://ittysockets.io), a free, fast, and private public service.  The idea is simple:
+
+1. Connect to a channel using a unique name (you choose it)
+2. Send messages to the channel (from one or more parties)
+3. Listen for messages in the channel (from one or more parties)
+4. Profit.
+
+This is an easy way to transmit messages between clients, but comes with limitations and considerations:
+
+1. **There is no history/replay.**  It's a live stream.
+2. **We don't authenticate.**  Itty Sockets leverages security merely through obfuscation (a near-infinite number of channel names).  Use a secure channel name and/or encode your payloads if concerned about eavesdropping. Add your own authentication layer, if needed.
+3. **There are no guarantees of delivery.**  Itty Sockets is not a traditional messaging system.  It's a public service that is provided without any guarantees of delivery, order, or persistence.  Use it for real-time communication, not for mission-critical data.
+
+
+
+### Privacy Concerns
+**We do not store any messages or data**
+There is intentionally no message logging or tracking of any kind.  It's easier for us that way, and safer for you.
+
+## Browser Usage
+
+If you want to send/receive messages from the browser (e.g. for sending information from one web page or tab to another), copy and paste this snippet directly into your browser console, then use as normal.
+
+<!-- BEGIN SNIPPET -->
+```ts
+let connect=(e,s={})=>{let t,n=[],o=[],a=0,r=()=>{t||(t=new WebSocket(`wss://ittysockets.io/r/${e??""}?${new URLSearchParams(s)}`),t.onopen=()=>{for(;n.length;)t?.send(n.shift());a&&t?.close()},t.onmessage=(e,s=JSON.parse(e.data))=>{for(let e of o)e({...s,date:new Date(s.date)})},t.onclose=()=>(a=0,t=null))};return new Proxy(r,{get:(e,s,l)=>({ws:t,send:(e,s)=>(e=JSON.stringify(e),e=s?`@@${s}@@${e}`:e,1==t?.readyState?t.send(e)??l:(n.push(e),r()??l)),push:(e,s)=>(a=1,l.send(e,s)),listen:(e,s)=>(o.push((t=>(!s||s(t))&&e(t))),r()??l),close:()=>(1==t?.readyState?t.close():a=1,l)}[s])})};
+```
+<!-- END SNIPPET -->
+
+afterwards:
+```ts
+// send a message on connect 'foo'
+connect('foo').push('hello world!')
+```
+
+## API
+
+| METHOD | DESCRIPTION | EXAMPLE |
+| --- | --- | --- |
+| **connect(id, options)** | Creates a new connect | `connect('foo')` |
+| **send(message)** | Sends a message to the room | `room.send({ type: 'chat', text: 'hello' })` |
+| **push(message)** | Sends a message and closes the connection | `room.push({ type: 'goodbye' })` |
+| **listen(fn)** | Adds a message listener | `room.listen(msg => console.log(msg))` |
+| **close()** | Closes the connection | `room.close()` |
+
+### Available Options
+
+| OPTION | DESCRIPTION | DEFAULT | EXAMPLE |
+| --- | --- | --- | --- |
+| **alias** | An optional display name for the connection | `undefined` | `{ alias: 'Kevin' }` |
+| **echo** | Whether to echo messages back to the sender | `false` | `{ echo: true }` |
+
+
+## Message Format
+```ts
+type Message = {
+  id: string      // unique message ID
+  date: Date      // JavaScript Date object
+  message: any    // the message payload
+}
+```
+
+
+

package/bunfig.toml

@@ -0,0 +1,3 @@
+[test]
+coverage = true
+coverageReporter  = ["text", "lcov"]

package/eslint.config.mjs

@@ -0,0 +1,43 @@
+import typescriptEslint from '@typescript-eslint/eslint-plugin'
+import tsParser from '@typescript-eslint/parser'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import js from '@eslint/js'
+import { FlatCompat } from '@eslint/eslintrc'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+const compat = new FlatCompat({
+    baseDirectory: __dirname,
+    recommendedConfig: js.configs.recommended,
+    allConfig: js.configs.all
+})
+
+export default [...compat.extends(
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+), {
+    plugins: {
+        '@typescript-eslint': typescriptEslint,
+    },
+
+    languageOptions: {
+        parser: tsParser,
+    },
+
+    rules: {
+        '@typescript-eslint/no-empty-function': 'off',
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/ban-types': 'off',
+        '@typescript-eslint/ban-ts-comment': 'off',
+        'linebreak-style': ['error', 'unix'],
+        'prefer-const': 'off',
+
+        quotes: ['error', 'single', {
+            allowTemplateLiterals: true,
+        }],
+
+        semi: ['error', 'never'],
+    },
+}]

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "itty-sockets",
+  "version": "0.0.0",
+  "description": "An easier way to handle WebSockets, in an itty package.",
+  "main": "./sockets.js",
+  "module": "./sockets.mjs",
+  "types": "./sockets.d.ts",
+  "scripts": {
+    "dev": "bun test --watch",
+    "lint": "bun eslint src",
+    "verify": "echo 'verifying module...' && bun run build && bun test",
+    "prerelease": "bun run verify",
+    "prerelease:next": "bun run verify",
+    "prebuild": "rimraf dist && mkdir dist",
+    "build": "rollup -c && node scripts/inject-snippet.mjs",
+    "release": "release --tag --push --patch --src=dist",
+    "release:next": "release --tag --push --type=next --src=dist"
+  },
+  "keywords": [
+    "websockets",
+    "realtime",
+    "free",
+    "p2p"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kwhitley/itty-sockets.git"
+  },
+  "author": "Kevin R. Whitley <krwhitley@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/kwhitley/itty-sockets/issues"
+  },
+  "devDependencies": {
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/bun": "^1.2.3",
+    "@typescript-eslint/eslint-plugin": "^8.18.0",
+    "@typescript-eslint/parser": "^8.18.0",
+    "eslint": "^9.17.0",
+    "globby": "^14.1.0",
+    "rimraf": "^6.0.1",
+    "rollup": "^4.28.1",
+    "rollup-plugin-bundle-size": "^1.0.3",
+    "rollup-plugin-copy": "^3.5.0",
+    "typescript": "^5.7.2",
+    "yarn-release": "^1.10.6"
+  },
+  "exports": {
+    ".": {
+      "import": "./index.mjs",
+      "require": "./index.js",
+      "types": "./index.d.ts"
+    },
+    "./connect": {
+      "import": "./connect.mjs",
+      "require": "./connect.js",
+      "types": "./connect.d.ts"
+    },
+    "./ws": {
+      "import": "./ws.mjs",
+      "require": "./ws.js",
+      "types": "./ws.d.ts"
+    }
+  }
+}

package/rollup.config.mjs

@@ -0,0 +1,82 @@
+import terser from '@rollup/plugin-terser'
+import typescript from '@rollup/plugin-typescript'
+import fs from 'fs-extra'
+import { globby } from 'globby'
+import bundleSize from 'rollup-plugin-bundle-size'
+import copy from 'rollup-plugin-copy'
+
+// scan files to build
+const files = (await globby('./src/*.ts', {
+  ignore: ['**/*.spec.ts', '**/types.ts'],
+})).map(path => ({
+  path,
+  shortPath: path.replace(/(\/src)|(\.ts)/g, '').replace('./index', '.'),
+  esm: path.replace('/src/', '/dist/').replace('.ts', '.mjs'),
+  cjs: path.replace('/src/', '/dist/').replace('.ts', '.js'),
+  types: path.replace('/src/', '/dist/').replace('.ts', '.d.ts'),
+})).sort((a, b) => a.shortPath.toLowerCase() < b.shortPath.toLowerCase() ? -1 : 1)
+
+// read original package.json
+const pkg = await fs.readJSON('./package.json')
+
+// create updated exports list from build files
+pkg.exports = files.reduce((acc, file) => {
+  acc[file.shortPath] = {
+    import: file.esm.replace('/dist', ''),
+    require: file.cjs.replace('/dist', ''),
+    types: file.types.replace('/dist', ''),
+  }
+
+  return acc
+}, {})
+
+// write updated package.json
+await fs.writeJSON('./package.json', pkg, { spaces: 2 })
+
+export default async () => {
+  console.log(files.map(f => f.path))
+
+  // export base files
+  return [
+    ...files.map(file => ({
+      input: file.path,
+      output: [
+        {
+          format: 'esm',
+          file: file.esm,
+          sourcemap: false,
+        },
+        {
+          format: 'cjs',
+          file: file.cjs,
+          sourcemap: false,
+        },
+      ],
+      plugins: [
+        typescript({ sourceMap: false }),
+        terser(),
+        bundleSize(),
+        copy({
+          targets: [
+            {
+              src: ['LICENSE'],
+              dest: 'dist',
+            },
+          ],
+        }),
+      ],
+    })),
+    {
+      input: 'src/connect.ts',
+      output: {
+        file: 'dist/connect.snippet.js',
+        format: 'esm',
+        name: 'connect',
+      },
+      plugins: [
+        typescript(),
+        terser(),
+      ],
+    },
+  ]
+}

package/scripts/inject-snippet.mjs

@@ -0,0 +1,19 @@
+import fs from 'fs'
+
+const transformCode = code => code
+  .replace(/^const\s+(\w+)\s*=/, 'let connect=')
+  .replace(/;export\s*{[^}]+};?\s*$/, ';')
+
+const snippet = fs.readFileSync('dist/connect.snippet.js', 'utf-8')
+const transformed = transformCode(snippet).trim()
+
+// Write transformed code to both files
+fs.writeFileSync('dist/connect.snippet.js', transformed)
+
+const readme = fs.readFileSync('README.md', 'utf-8')
+const newReadme = readme.replace(
+  /(<!-- BEGIN SNIPPET -->[\r\n]+```(?:js|ts)[\r\n]).*?([\r\n]```[\r\n]+<!-- END SNIPPET -->)/s,
+  `$1${transformed}$2`
+)
+
+fs.writeFileSync('README.md', newReadme)

package/src/connect.spec.ts

@@ -0,0 +1,211 @@
+import { describe, expect, it, beforeEach, afterEach } from 'bun:test'
+import { connect, MessageEvent, type Connection } from './connect'
+
+describe('connect', () => {
+  const getChannelID = () => 'itty:itty-sockets:test-' + Math.random().toString(36).slice(2)
+  const setup = () => connect(getChannelID(), { echo: true })
+
+  const tests = [
+    {
+      group: 'methods',
+      cases: [
+        {
+          name: 'exposes .send, .push, .listen, .close',
+          run: (channel: Connection) => {
+            for (const method of ['send', 'push', 'listen', 'close']) {
+              expect(typeof channel[method]).toBe('function')
+            }
+          }
+        }
+      ]
+    },
+    {
+      group: 'server options',
+      cases: [
+        {
+          name: 'echo > sends messages back to sender',
+          run: () => new Promise<void>((resolve, reject) => {
+            const channel = connect(getChannelID(), { echo: true })
+
+            channel.listen(msg => {
+              expect(msg.message).toBe('test')
+              resolve()
+            })
+            channel.send('test')
+          })
+        },
+        {
+          name: 'as > sets alias for messages',
+          run: () => new Promise<void>((resolve, reject) => {
+            const channel = connect(getChannelID(), { echo: true, as: 'test-user' })
+            const timeout = setTimeout(() => reject(new Error('No message received')), 150)
+
+            channel.listen(msg => {
+              clearTimeout(timeout)
+              expect(msg.alias).toBe('test-user')
+              resolve()
+            })
+            channel.send('test')
+          })
+        }
+      ]
+    },
+    {
+      group: 'message handling',
+      cases: [
+        {
+          name: 'MessageEvent > includes expected fields',
+          run: () => new Promise<void>((resolve, reject) => {
+            const channel = setup()
+            const timeout = setTimeout(() => reject(new Error('No message received')), 150)
+
+            channel.listen(msg => {
+              clearTimeout(timeout)
+              expect(msg.date instanceof Date).toBe(true)
+              expect(typeof msg.uid).toBe('string')
+              expect(msg.message).toBe('test')
+              resolve()
+            })
+            channel.send('test')
+          })
+        },
+        {
+          name: 'handles conditional message listening',
+          run: () => new Promise<void>((resolve, reject) => {
+            const channel = setup()
+            let receivedCount = 0
+            const timeout = setTimeout(() => reject(new Error('Test timeout')), 150)
+
+            channel.listen(
+              msg => {
+                receivedCount++
+                if (receivedCount === 1) {
+                  clearTimeout(timeout)
+                  resolve()
+                }
+              },
+              msg => msg.message.type === 'test'
+            )
+
+            channel.send({ type: 'test' })
+            channel.send({ type: 'other' })
+          })
+        },
+        {
+          name: 'when predicate blocks messages',
+          run: (channel: Connection) => new Promise<void>((resolve) => {
+            let called = false
+            channel
+              .listen(
+                () => { called = true },
+                () => false // when predicate always returns false
+              )
+              .send('test')
+
+            setTimeout(() => {
+              expect(called).toBe(false)
+              resolve()
+            }, 100)
+          })
+        },
+        {
+          name: 'sends private messages to recipient',
+          run: (channel: Connection) => new Promise<void>((resolve, reject) => {
+            const recipient = 'user-' + Math.random().toString(36).slice(2)
+            const message = 'private-message'
+
+            channel
+              .listen(e => {
+                expect(e.uid).toBeUndefined()
+                expect(e.message).toContain(recipient)
+                resolve()
+              })
+              .send(message, recipient)
+          })
+        },
+        {
+          name: 'handles multiple listeners for same message',
+          run: (channel: Connection) => new Promise<void>((resolve) => {
+            let count = 0
+            const listener1 = () => count++
+            const listener2 = () => count++
+
+            channel
+              .listen(listener1)
+              .listen(listener2)
+              .send('test')
+
+            setTimeout(() => {
+              expect(count).toBe(2)
+              resolve()
+            }, 100)
+          })
+        }
+      ]
+    },
+    {
+      group: 'message queueing',
+      cases: [
+        {
+          name: 'processes queued messages in order',
+          run: () => new Promise<void>((resolve, reject) => {
+            const channel = setup()
+            const messages = ['first', 'second', 'third']
+            const received: any[] = []
+            const timeout = setTimeout(() => reject(new Error('Queue timeout')), 150)
+
+            channel.listen(msg => {
+              received.push(msg.message)
+              if (received.length === messages.length) {
+                clearTimeout(timeout)
+                expect(received).toEqual(messages)
+                resolve()
+              }
+            })
+
+            messages.forEach(msg => channel.send(msg))
+          })
+        }
+      ]
+    },
+    {
+      group: 'push behavior',
+      cases: [
+        {
+          name: 'sends message and closes immediately',
+          run: async () => {
+            const cid = getChannelID()
+            const channel = connect(cid)
+            const receiver = connect(cid)
+            const message = 'push-test'
+
+            return new Promise<void>((resolve, reject) => {
+              const timeout = setTimeout(() => reject(new Error('Push timeout')), 150)
+
+              receiver.listen(msg => {
+                clearTimeout(timeout)
+                expect(msg.message).toBe(message)
+
+                setTimeout(() => {
+                  expect(channel.ws).toBeNull()
+                  resolve()
+                }, 50)
+              })
+
+              channel.push(message)
+            })
+          }
+        }
+      ]
+    }
+  ]
+
+  // Generate tests from data structure
+  for (const { group, cases } of tests) {
+    describe(group, () => {
+      for (const { name, run } of cases) {
+        it(name, () => run(setup()))
+      }
+    })
+  }
+})

package/src/connect.ts

@@ -0,0 +1,99 @@
+export type AllowedProperty = 'ws' | 'send' | 'push' | 'listen' | 'close'
+
+export type MessageEvent<MessageType = any> = {
+  date: Date
+  uid?: string
+  alias?: string
+  message: MessageType
+}
+
+export type SendMessage = <MessageFormat = any>(message: MessageFormat, recipient?: string) => Connection
+
+export type Connection = {
+  ws?: WebSocket,
+  send: SendMessage,
+  push: SendMessage,
+  listen: <MessageType = any>(
+    listener: (event: MessageEvent<MessageType>) => any,
+    when?: (event: MessageEvent<MessageType>) => any,
+  ) => Connection,
+  close: () => Connection,
+}
+
+export const connect = (id: string, options: Record<string, any> = {}): Connection => {
+  let ws: WebSocket | null,
+    queue: string[] = [],
+    listeners: Array<(event: MessageEvent) => any> = [],
+    closeAfterSend = 0
+
+  let connect = () => {
+    if (ws) return // Don't reconnect if already opening/open
+
+    ws = new WebSocket(`wss://ittysockets.io/r/${id??''}?${new URLSearchParams(options)}`)
+
+    ws.onopen = () => {
+      while (queue.length) ws?.send(queue.shift()!)
+      if (closeAfterSend) ws?.close()
+    }
+
+    ws.onmessage = (
+      event: any,
+      parsed = JSON.parse(event.data),
+    ) => {
+      for (let listener of listeners)
+        listener({ ...parsed, date: new Date(parsed.date) })
+    }
+
+    ws.onclose = () => (closeAfterSend = 0, ws = null)
+  }
+
+  // @ts-ignore
+  return new Proxy(connect, {
+    get: (_, key: AllowedProperty, __) =>
+      ({
+        ws,
+        send: (message: any, recipient?: string) => {
+          message = JSON.stringify(message)
+          message = recipient ? `@@${recipient}@@${message}` : message
+          if (ws?.readyState == 1) return ws.send(message) ?? __
+          queue.push(message)
+
+          return connect() ?? __
+        },
+        push: (message: any, recipient?: string) => {
+          closeAfterSend = 1
+          return __.send(message, recipient)
+        },
+        listen: <MessageType = any>(
+          listener: (event: MessageEvent<MessageType>) => any,
+          when?: (event: MessageEvent<MessageType>) => boolean
+        ) => {
+          listeners.push((event: MessageEvent<any>) =>
+            (!when || when(event as MessageEvent<MessageType>)) && listener(event as MessageEvent<MessageType>)
+          )
+          return connect() ?? __
+        },
+        close: () => (ws?.readyState == 1 ? ws.close() : (closeAfterSend = 1), __)
+      })[key]
+  })
+}
+
+// type FooMessage = {
+//   name: string
+//   age: number
+//   pets: string[]
+// }
+// type XYMessage = {
+//   x: number
+//   y: number
+// }
+
+// connect('test')
+//   .listen<FooMessage>(({ message }) => {
+//     console.log(message.name)
+//   }, (msg) => msg.message.name)
+//   .listen<XYMessage>(({ message }) => {
+//     console.log(message.x, message.y)
+//   }, (msg) => msg.message.x !== undefined)
+//   .listen<{ x: number }>(e => e.message.foo == 'bar')
+//   .push<{ x: number }>({ foo: 'bar' })

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './connect'
+export * from './ws'

package/src/ws.spec.ts

@@ -0,0 +1,149 @@
+import { describe, expect, it } from 'bun:test'
+import { ws, type Connection, type ConnectionOptions } from './ws'
+
+describe('ws', () => {
+  const getURL = (id: string) =>
+    `wss://ittysockets.io/r/itty:itty-sockets:test-${id}?echo=true`
+
+  const setup = (options: ConnectionOptions = {}) => {
+    const id = Math.random().toString(36).slice(2)
+    return ws(getURL(id), options)
+  }
+
+  const tests = [
+    {
+      group: 'basics',
+      cases: [
+        {
+          name: 'is a function',
+          run: () => expect(typeof ws).toBe('function')
+        },
+        {
+          name: 'returns proxy with methods',
+          run: conn => ['send', 'push', 'listen', 'close'].forEach(
+            method => expect(typeof conn[method]).toBe('function')
+          )
+        }
+      ]
+    },
+    {
+      group: 'connection behavior',
+      cases: [
+        {
+          name: 'does not connect until triggered',
+          run: conn => expect(conn.ws).toBeUndefined()
+        },
+        {
+          name: 'exposes raw websocket after connection',
+          run: () => new Promise<void>((resolve, reject) => {
+            const conn = setup()
+            const timeout = setTimeout(() => reject(new Error('Connection timeout')), 150)
+
+            conn.listen(() => {
+              clearTimeout(timeout)
+              expect(conn.ws instanceof WebSocket).toBe(true)
+              expect(typeof conn.ws?.send).toBe('function')
+              expect(typeof conn.ws?.close).toBe('function')
+              resolve()
+            })
+
+            conn.send('test')
+          })
+        },
+        {
+          name: 'reconnects after close',
+          run: () => {
+            const conn = setup({ json: true })
+            conn
+              .listen((e) => {
+                if (e.message === 'end') {
+                  expect(e.message).toBe('end')
+                }
+              })
+              .send('start')
+              .close()
+
+            setTimeout(() => {
+              conn.send('end')
+            }, 50)
+          }
+        }
+      ]
+    },
+    {
+      group: 'message handling',
+      cases: [
+        {
+          name: 'notifies listeners',
+          run: () => new Promise<void>((resolve, reject) => {
+            const conn = setup({ json: true })
+            const timeout = setTimeout(() => reject(new Error('No message received')), 150)
+
+            conn.listen(e => {
+              clearTimeout(timeout)
+              expect(e.message).toBe('test-message')
+              resolve()
+            })
+
+            conn.send('test-message')
+          })
+        },
+        {
+          name: 'handles json option',
+          run: () => new Promise<void>((resolve, reject) => {
+            const conn = ws(getURL(Math.random().toString(36).slice(2)), { json: true })
+            const data = { hello: 'world' }
+            const timeout = setTimeout(() => reject(new Error('No message received')), 150)
+
+            conn.listen(e => {
+              clearTimeout(timeout)
+              expect(e.message).toEqual(data)
+              resolve()
+            })
+
+            conn.send(data)
+          })
+        }
+      ]
+    },
+    {
+      group: 'push behavior',
+      cases: [
+        {
+          name: 'sends message and closes',
+          run: async () => {
+            const id = Math.random().toString(36).slice(2)
+            const sender = ws(getURL(id), { json: true })
+            const receiver = ws(getURL(id), { json: true })
+            const message = 'push-test'
+
+            return new Promise<void>((resolve, reject) => {
+              const timeout = setTimeout(() => reject(new Error('Push timeout')), 150)
+
+              receiver.listen(e => {
+                clearTimeout(timeout)
+                expect(e.message).toBe(message)
+
+                setTimeout(() => {
+                  expect(sender.ws).toBeNull()
+                  resolve()
+                }, 50)
+              })
+
+              sender.push(message)
+            })
+          }
+        }
+      ]
+    }
+  ]
+
+  // Generate tests from data structure
+  for (const { group, cases } of tests) {
+    describe(group, () => {
+      for (const { name, run } of cases) {
+        it(name, () => run(setup()))
+      }
+    })
+  }
+})

package/src/ws.ts

@@ -0,0 +1,89 @@
+
+type AllowedProperty = 'ws' | 'send' | 'push' | 'listen' | 'close'
+
+type SendMessage = <MessageFormat = any>(message: MessageFormat) => Connection
+
+export type Connection = {
+  ws?: WebSocket | null,
+  send: SendMessage,
+  push: SendMessage,
+  listen: <MessageType = any>(
+    listener: (message: MessageType) => any,
+    when?: (message: MessageType) => any,
+  ) => Connection,
+  close: () => Connection,
+}
+
+export type ConnectionOptions = {
+  json?: boolean,
+}
+
+export const ws = (url: string, options: ConnectionOptions = {}): Connection => {
+  let ws: WebSocket | null,
+    queue: string[] = [],
+    listeners: Array<(message: any) => any> = [],
+    closeAfterSend = 0
+
+  let connect = () => {
+    if (ws) return // Don't reconnect if already opening/open
+    ws = new WebSocket(url)
+
+    ws.onopen = () => {
+      while (queue.length) ws?.send(queue.shift()!)
+      if (closeAfterSend) ws?.close()
+    }
+
+    ws.onmessage = (
+      event: MessageEvent,
+      message = options.json ? JSON.parse(event.data) : event.data,
+    ) => {
+      for (let listener of listeners)
+        listener(message)
+    }
+
+    ws.onclose = () => (closeAfterSend = 0, ws = null)
+  }
+
+  // @ts-ignore
+  return new Proxy(connect, {
+    get: (_, key: AllowedProperty, __) =>
+      ({
+        ws,
+        send: (message: any) => {
+          message = options.json ? JSON.stringify(message) : message
+          if (ws?.readyState == 1) return ws.send(message) ?? __
+          queue.push(message)
+          return connect() ?? __
+        },
+        push: (message: any) => {
+          closeAfterSend = 1
+          return __.send(message)
+        },
+        listen: <T = any>(listener: (message: T) => any, when?: (message: T) => any) => {
+          listeners.push(msg => (!when || when(msg)) && listener(msg))
+          return connect() ?? __
+        },
+        // @ts-ignore
+        close: () => (ws?.readyState == 1 ? ws.close() : (closeAfterSend = 1), __)
+      })[key]
+  })
+}
+
+// type CustomMessage = {
+//   foo: string,
+//   age: number,
+// }
+
+// type XYMessage = {
+//   x: number,
+//   y: number,
+// }
+
+// const checker = (message: XYMessage) => message.age === 1
+
+// ws('wss://localhost:8080', { json: true })
+//   .listen<CustomMessage>(message => {
+//     console.log(message.foo)
+//   }, checker)
+//   .send<{ x: number }>({ foo: 'bar' })
+//   .push<{ x: number }>({ foo: 'bar' })

package/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true,
+    "baseUrl": "src",
+    "declaration": true,
+    "sourceMap": false,
+    "esModuleInterop": true,
+    "inlineSourceMap": false,
+    "lib": ["esnext", "es2015", "dom"],
+    "listEmittedFiles": false,
+    "listFiles": false,
+    "noFallthroughCasesInSwitch": true,
+    "pretty": true,
+    // "moduleResolution": "nodeNext",  // disabled to be compatible with module: "esnext"
+    // "resolveJsonModule": true,       // disabled to be compatible with module: "esnext"
+    "rootDir": "src",
+    "skipLibCheck": true,
+    "strict": true,
+    "traceResolution": false,
+    "outDir": "",
+    "target": "esnext",
+    "module": "esnext"
+  },
+  "exclude": ["node_modules", "dist", "**/*.spec.ts", "examples"],
+  "include": ["src", "src/seconds.ts"]
+}