{"id":31376522,"url":"https://github.com/substrate-system/__old_mergeparty","last_synced_at":"2025-09-28T03:54:01.507Z","repository":{"id":310008890,"uuid":"1038297794","full_name":"substrate-system/__old_mergeparty","owner":"substrate-system","description":"Automerge + Partykit","archived":false,"fork":false,"pushed_at":"2025-08-24T02:50:10.000Z","size":115,"stargazers_count":3,"open_issues_count":3,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-09T08:15:41.762Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/substrate-system.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-15T00:22:41.000Z","updated_at":"2025-09-08T15:45:43.000Z","dependencies_parsed_at":"2025-08-21T05:42:24.390Z","dependency_job_id":null,"html_url":"https://github.com/substrate-system/__old_mergeparty","commit_stats":null,"previous_names":["substrate-system/merge-party2","substrate-system/mergeparty"],"tags_count":1,"template":false,"template_full_name":"nichoth/template-ts-browser","purl":"pkg:github/substrate-system/__old_mergeparty","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/substrate-system%2F__old_mergeparty","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/substrate-system%2F__old_mergeparty/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/substrate-system%2F__old_mergeparty/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/substrate-system%2F__old_mergeparty/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/substrate-system","download_url":"https://codeload.github.com/substrate-system/__old_mergeparty/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/substrate-system%2F__old_mergeparty/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":277322052,"owners_count":25798726,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-28T02:00:08.834Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-09-28T03:53:56.969Z","updated_at":"2025-09-28T03:54:01.499Z","avatar_url":"https://github.com/substrate-system.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Merge Party\n[![tests](https://img.shields.io/github/actions/workflow/status/substrate-system/mergeparty/nodejs.yml?style=flat-square)](https://github.com/substrate-system/mergeparty/actions/workflows/nodejs.yml)\n[![types](https://img.shields.io/npm/types/@substrate-system/mergeparty?style=flat-square)](README.md)\n[![module](https://img.shields.io/badge/module-ESM%2FCJS-blue?style=flat-square)](README.md)\n[![semantic versioning](https://img.shields.io/badge/semver-2.0.0-blue?logo=semver\u0026style=flat-square)](https://semver.org/)\n[![Common Changelog](https://nichoth.github.io/badge/common-changelog.svg)](./CHANGELOG.md)\n[![install size](https://flat.badgen.net/packagephobia/install/@substrate-system/mergeparty)](https://packagephobia.com/result?p=@substrate-system/mergeparty)\n[![license](https://img.shields.io/badge/license-Big_Time-blue?style=flat-square)](LICENSE)\n\nAutomerge + Partykit.\n\nBased on [automerge-repo-sync-server](https://github.com/automerge/automerge-repo-sync-server).\n\nThis creates 1 partykit room per document, using the automerge document ID as\nthe room name.\n\n\u003cdetails\u003e\u003csummary\u003e\u003ch2\u003eContents\u003c/h2\u003e\u003c/summary\u003e\n\n\u003c!-- toc --\u003e\n\n- [Install](#install)\n- [Use](#use)\n  * [Backend](#backend)\n  * [Browser Client](#browser-client)\n- [Modules](#modules)\n  * [ESM](#esm)\n  * [Common JS](#common-js)\n- [Develop](#develop)\n  * [start a localhost server](#start-a-localhost-server)\n  * [start partykit](#start-partykit)\n\n\u003c!-- tocstop --\u003e\n\n\u003c/details\u003e\n\n## Install\n\n```sh\nnpm i -S @substrate-system/mergeparty\n```\n\n## Use\n\nCreate a backend (the websocket/partykit server) and a browser client.\n\n### Backend\n\nJust need to export a class that extends the `MergeParty` class from this\nmodule.\n\nSee [./example_backend](./example_backend/).\n\n```js\nimport { MergeParty, CORS } from '@substrate-system/mergeparty/server'\n\nexport default class ExampleServer extends MergeParty {\n  static async onBeforeConnect (request:Party.Request, _lobby:Party.Lobby) {\n    // auth goes here\n  }\n}\n```\n\n#### HTTP\n\nAlso you can make HTTP calls to the server:\n\n```\nhttp://localhost:1999/parties/main/\u003cdocument-id-here\u003e\n```\n\nYou should see a response\n\n```\n👍 All good\n```\n\n##### `/health`\n\n```\nhttp://localhost:1999/parties/main/\u003cdocument-id-here\u003e/health\n```\n\nResponse:\n\n```js\n{\n  \"status\": \"ok\",\n  \"room\": \"my-document-id\",\n  \"connectedPeers\": 0\n}\n```\n\n### Browser Client\n\nSee [./example/](./example/) for the browser version.\n\nThis is a small wrapper around [@automerge/automerge-repo-network-websocket](https://github.com/automerge/automerge-repo/tree/main/packages/automerge-repo-network-websocket),\njust adding some parameters for partykit.\n\n```ts\nexport class PartykitNetworkAdapter extends WebSocketClientAdapter {\n    constructor (options:{\n      host?:string\n      room:string\n      party?:string\n    })\n```\n\n#### Browser Example\n\nCreate a new in-browser automerge node.\n\n```ts\nimport {\n    IndexedDBStorageAdapter\n} from '@automerge/automerge-repo-storage-indexeddb'\nimport { PartykitNetworkAdapter } from '@substrate-system/merge-party/client'\n\nconst repo = new Repo({\n    storage: new IndexedDBStorageAdapter(),\n})\n\nconst doc = repo.create({ text: '' })\ndocumentId = doc.documentId\n\n// use the document ID as the room name\nconst networkAdapter = new PartykitNetworkAdapter({\n    host: PARTYKIT_HOST,\n    room: documentId\n})\n\nrepo.networkSubsystem.addNetworkAdapter(networkAdapter)\nawait networkAdapter.whenReady()\n\n// ... use the repo ...\n```\n\n## Modules\n\nThis exposes ESM and common JS via\n[package.json `exports` field](https://nodejs.org/api/packages.html#exports).\n\n### ESM\n```js\nimport { MergeParty } from '@substrate-system/mergeparty'\n```\n\n### Common JS\n```js\nrequire('@substrate-system/mergeparty')\n```\n\n-----------------\n\n## Develop\n\n### start a localhost server\n\nUse vite + local partykit server.\n\n```sh\nnpm start\n```\n\n### start partykit\n\n```sh\nnpx partykit dev\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsubstrate-system%2F__old_mergeparty","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsubstrate-system%2F__old_mergeparty","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsubstrate-system%2F__old_mergeparty/lists"}