@usearete/sdk 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Arete
+
+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,111 @@
+# Arete TypeScript SDK
+
+Pure TypeScript SDK for the Arete Solana streaming platform. Framework-agnostic core with AsyncIterable-based streaming.
+
+## Installation
+
+```bash
+npm install @usearete/sdk
+```
+
+## Usage
+
+### Setup
+
+```typescript
+import { Arete } from '@usearete/sdk';
+import { SETTLEMENT_GAME_STACK } from './generated/settlement-game-stack';
+
+const a4 = await Arete.connect('wss://mainnet.arete.xyz', {
+  stack: SETTLEMENT_GAME_STACK,
+});
+```
+
+### Streaming with AsyncIterable
+
+```typescript
+for await (const update of a4.views.settlementGame.list.watch()) {
+  if (update.type === 'upsert') {
+    console.log('Game updated:', update.key, update.data);
+  } else if (update.type === 'delete') {
+    console.log('Game deleted:', update.key);
+  }
+}
+
+for await (const update of a4.views.settlementGame.state.watch('game-123')) {
+  console.log('Game 123 updated:', update.data);
+}
+
+for await (const update of a4.views.settlementGame.list.watchRich()) {
+  if (update.type === 'updated') {
+    console.log('Changed from:', update.before);
+    console.log('Changed to:', update.after);
+  }
+}
+```
+
+### One-Shot Queries
+
+```typescript
+const games = await a4.views.settlementGame.list.get();
+
+const game = await a4.views.settlementGame.state.get('game-123');
+```
+
+### Connection Management
+
+```typescript
+console.log(a4.connectionState);
+
+const unsubscribe = a4.onConnectionStateChange((state) => {
+  console.log('Connection state:', state);
+});
+
+await a4.disconnect();
+```
+
+## API
+
+### Arete
+
+Main client class with typed view accessors.
+
+- `Arete.connect(url, options)` - Connect to a Arete server
+- `views` - Typed view accessors based on your stack definition
+- `connectionState` - Current connection state
+- `onConnectionStateChange(callback)` - Listen for connection changes
+- `disconnect()` - Disconnect from the server
+
+### Views
+
+Each view provides:
+
+**StateView (keyed entities)**
+- `watch(key)` - AsyncIterable of updates for a specific key
+- `watchRich(key)` - AsyncIterable with before/after diffs
+- `get(key)` - Get entity by key
+- `getSync(key)` - Get entity synchronously (if available)
+
+**ListView (collections)**
+- `watch()` - AsyncIterable of all updates
+- `watchRich()` - AsyncIterable with before/after diffs
+- `get()` - Get all entities
+- `getSync()` - Get all entities synchronously (if available)
+
+### Update Types
+
+```typescript
+type Update<T> =
+  | { type: 'upsert'; key: string; data: T }
+  | { type: 'patch'; key: string; data: Partial<T> }
+  | { type: 'delete'; key: string };
+
+type RichUpdate<T> =
+  | { type: 'created'; key: string; data: T }
+  | { type: 'updated'; key: string; before: T; after: T; patch?: unknown }
+  | { type: 'deleted'; key: string; lastKnown?: T };
+```
+
+## License
+
+MIT