@automerge/react 2.0.0-beta.2

package/README.md

@@ -0,0 +1,70 @@
+# @automerge/react
+
+A minimalist React package for Automerge Repo; does nothing but re-export other packages for your convenience.
+
+## Installation
+
+```bash
+npm install @automerge/react
+# or
+yarn add @automerge/react
+# or
+pnpm add @automerge/react
+```
+
+## Usage
+
+```tsx
+import { createRepo, useDocument } from "@automerge/react"
+
+// Create a pre-configured repo instance
+const repo = createRepo({
+  websocketUrl: "ws://localhost:8080", // optional
+  enableStorage: true, // optional, defaults to true
+  enableMessageChannel: true, // optional, defaults to true
+})
+
+// Use in your React components
+function MyComponent() {
+  const doc = useDocument(repo, "my-doc-id")
+
+  if (!doc) return <div>Loading...</div>
+
+  return <div>{doc.content}</div>
+}
+```
+
+## Features
+
+- Pre-configured Automerge Repo setup with common adapters
+- Re-exports all React hooks from `@automerge/automerge-repo-react-hooks`
+- TypeScript support
+- Minimalist API surface
+
+## API
+
+### `createRepo(options?: CreateRepoOptions)`
+
+Creates a pre-configured Automerge Repo instance with common adapters.
+
+Options:
+
+- `websocketUrl?: string` - The URL of the WebSocket server to connect to
+- `enableStorage?: boolean` - Whether to enable IndexedDB storage (default: true)
+- `enableMessageChannel?: boolean` - Whether to enable MessageChannel network adapter (default: true)
+
+### Hooks
+
+All hooks from `@automerge/automerge-repo-react-hooks` are re-exported:
+
+- `useRepo`
+- `useDocument`
+- `useHandle`
+- `useLocalAwareness`
+- `useRemoteAwareness`
+- `useBootstrap`
+- `useSyncState`
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * from "@automerge/automerge-repo";
+export * from "@automerge/automerge-repo-react-hooks";
+export { MessageChannelNetworkAdapter } from "@automerge/automerge-repo-network-messagechannel";
+export { BroadcastChannelNetworkAdapter } from "@automerge/automerge-repo-network-broadcastchannel";
+export { WebSocketClientAdapter } from "@automerge/automerge-repo-network-websocket";
+export { IndexedDBStorageAdapter } from "@automerge/automerge-repo-storage-indexeddb";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAA;AACzC,cAAc,uCAAuC,CAAA;AAErD,OAAO,EAAE,4BAA4B,EAAE,MAAM,kDAAkD,CAAA;AAC/F,OAAO,EAAE,8BAA8B,EAAE,MAAM,oDAAoD,CAAA;AACnG,OAAO,EAAE,sBAAsB,EAAE,MAAM,6CAA6C,CAAA;AACpF,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAA"}

package/dist/index.js

@@ -0,0 +1,6 @@
+export * from "@automerge/automerge-repo";
+export * from "@automerge/automerge-repo-react-hooks";
+export { MessageChannelNetworkAdapter } from "@automerge/automerge-repo-network-messagechannel";
+export { BroadcastChannelNetworkAdapter } from "@automerge/automerge-repo-network-broadcastchannel";
+export { WebSocketClientAdapter } from "@automerge/automerge-repo-network-websocket";
+export { IndexedDBStorageAdapter } from "@automerge/automerge-repo-storage-indexeddb";

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@automerge/react",
+  "version": "2.0.0-beta.2",
+  "description": "A quick-import React package for Automerge Repo",
+  "repository": "https://github.com/automerge/automerge-repo/tree/master/packages/automerge-react",
+  "author": "Peter van Hardenberg <pvh@pvh.ca>",
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "watch": "npm-watch build",
+    "test": "vitest",
+    "test:watch": "npm-watch test"
+  },
+  "dependencies": {
+    "@automerge/automerge-repo": "workspace:*",
+    "@automerge/automerge-repo-network-broadcastchannel": "workspace:*",
+    "@automerge/automerge-repo-network-messagechannel": "workspace:*",
+    "@automerge/automerge-repo-network-websocket": "workspace:*",
+    "@automerge/automerge-repo-storage-indexeddb": "workspace:*",
+    "@automerge/automerge-repo-react-hooks": "workspace:*",
+    "react": "^18.0.0"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^1.0.0"
+  },
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "watch": {
+    "build": {
+      "patterns": "./src/**/*",
+      "extensions": [
+        ".ts"
+      ]
+    },
+    "test": {
+      "quiet": true,
+      "patterns": [
+        "./src/**/*",
+        "./test/**/*"
+      ],
+      "extensions": [
+        ".ts"
+      ]
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/index.ts

@@ -0,0 +1,7 @@
+export * from "@automerge/automerge-repo"
+export * from "@automerge/automerge-repo-react-hooks"
+
+export { MessageChannelNetworkAdapter } from "@automerge/automerge-repo-network-messagechannel"
+export { BroadcastChannelNetworkAdapter } from "@automerge/automerge-repo-network-broadcastchannel"
+export { WebSocketClientAdapter } from "@automerge/automerge-repo-network-websocket"
+export { IndexedDBStorageAdapter } from "@automerge/automerge-repo-storage-indexeddb"

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "jsx": "react",
+    "module": "NodeNext",
+    "moduleResolution": "nodenext",
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "./dist",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "strictNullChecks": true,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["dist"]
+}