@lark-sh/client 0.1.13 → 0.1.15

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Bag of Holding, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -4,6 +4,17 @@ JavaScript/TypeScript client for [Lark](https://lark.sh) - a real-time database
 
 > **Early Alpha**: This library is under active development. APIs may change.
 
+## Features
+
+- **Firebase v8-style API** - Familiar `ref()`, `set()`, `on()`, `once()` patterns
+- **Real-time subscriptions** - Live updates with `child_added`, `child_changed`, `child_removed`, `child_moved`
+- **Full query support** - `orderByChild()`, `limitToFirst()`, `startAt()`, `endAt()`, and more
+- **Transactions** - Atomic updates with optimistic concurrency
+- **Local-first writes** - Optimistic updates appear instantly
+- **Works everywhere** - Browsers and Node.js
+- **TypeScript support** - Full type definitions included
+- **~10KB gzipped** - Lightweight bundle
+
 ## Installation
 
 ```bash
@@ -17,36 +28,267 @@ import { LarkDatabase } from '@lark-sh/client';
 
 const db = new LarkDatabase();
 
-// Connect to a database
-await db.connect('my-project/my-database', {
-  token: 'your-auth-token', // or use anonymous: true
-});
+// Connect with anonymous auth
+await db.connect('my-project/my-database', { anonymous: true });
 
-// Get a reference and read data
-const snapshot = await db.ref('users/alice').once();
-console.log(snapshot.val());
+// Or connect with a JWT token
+// await db.connect('my-project/my-database', { token: 'your-jwt-token' });
 
 // Write data
 await db.ref('users/alice').set({ name: 'Alice', score: 100 });
 
+// Read data once
+const snapshot = await db.ref('users/alice').once('value');
+console.log(snapshot.val()); // { name: 'Alice', score: 100 }
+
 // Subscribe to real-time updates
 const unsubscribe = db.ref('users').on('value', (snapshot) => {
   console.log('Users changed:', snapshot.val());
 });
 
-// Later: unsubscribe and disconnect
+// Child events with previousChildKey
+db.ref('messages').orderByKey().on('child_added', (snapshot, prevKey) => {
+  console.log('New message:', snapshot.key, 'after:', prevKey);
+});
+
+// Clean up
 unsubscribe();
 await db.disconnect();
 ```
 
-## Features
+## API Overview
+
+### Connection Management
+
+```typescript
+const db = new LarkDatabase();
+
+// Connect
+await db.connect('project/database', { anonymous: true });
+// or with token: { token: 'jwt-token' }
+
+// Check connection state
+db.connected;     // true if authenticated
+db.state;         // 'disconnected' | 'connecting' | 'connected' | 'joined' | 'authenticated'
+
+// Connection events
+db.onConnect(() => console.log('Connected'));
+db.onDisconnect(() => console.log('Disconnected'));
+db.onError((err) => console.error(err));
+
+// Pause/resume connection (preserves cache)
+db.goOffline();
+db.goOnline();
+
+// Full disconnect (clears all state)
+await db.disconnect();
+```
+
+### Reading & Writing Data
+
+```typescript
+const ref = db.ref('users/alice');
+
+// Write
+await ref.set({ name: 'Alice', score: 100 });
+await ref.update({ score: 150 });  // Partial update
+await ref.remove();
+
+// Read once
+const snapshot = await ref.once('value');
+snapshot.val();      // The data
+snapshot.key;        // 'alice'
+snapshot.exists();   // true/false
+
+// Push (auto-generated key)
+const newRef = await db.ref('messages').push({ text: 'Hello!' });
+console.log(newRef.key);  // '-N1a2b3c4d5e6f'
+
+// Priority
+await ref.setWithPriority({ name: 'Alice' }, 10);
+await ref.setPriority(20);
+```
+
+### Real-time Subscriptions
+
+```typescript
+// on() returns an unsubscribe function
+const unsubscribe = db.ref('users').on('value', (snapshot) => {
+  console.log(snapshot.val());
+});
+
+// Child events
+db.ref('messages').on('child_added', (snap, prevKey) => { /* ... */ });
+db.ref('messages').on('child_changed', (snap, prevKey) => { /* ... */ });
+db.ref('messages').on('child_removed', (snap) => { /* ... */ });
+db.ref('messages').on('child_moved', (snap, prevKey) => { /* ... */ });
+
+// Unsubscribe
+unsubscribe();
+```
+
+### Queries
+
+```typescript
+// Ordering
+db.ref('users').orderByChild('score');
+db.ref('users').orderByKey();
+db.ref('users').orderByValue();
+db.ref('users').orderByPriority();
+
+// Limiting
+db.ref('users').orderByChild('score').limitToFirst(10);
+db.ref('users').orderByChild('score').limitToLast(5);
+
+// Range queries
+db.ref('users').orderByChild('age').startAt(18).endAt(65);
+db.ref('users').orderByChild('name').equalTo('Alice');
+
+// Chaining
+const topPlayers = await db.ref('players')
+  .orderByChild('score')
+  .limitToLast(10)
+  .once('value');
+```
+
+### Transactions
+
+```typescript
+// Callback style (optimistic concurrency)
+const result = await db.ref('counter').transaction((current) => {
+  return (current || 0) + 1;
+});
+console.log(result.committed, result.snapshot.val());
+
+// Multi-path atomic updates
+await db.transaction({
+  '/users/alice/score': 100,
+  '/users/bob/score': 200,
+  '/temp/data': null,  // null = delete
+});
+
+// Array style with conditions
+await db.transaction([
+  { op: 'condition', path: '/counter', value: 5 },  // CAS check
+  { op: 'set', path: '/counter', value: 6 },
+]);
+```
+
+### OnDisconnect
+
+```typescript
+// Set data when client disconnects
+await db.ref('users/alice/online').onDisconnect().set(false);
+await db.ref('users/alice/lastSeen').onDisconnect().set(ServerValue.TIMESTAMP);
+
+// Remove data on disconnect
+await db.ref('presence/alice').onDisconnect().remove();
+
+// Cancel pending onDisconnect
+await db.ref('users/alice/online').onDisconnect().cancel();
+```
+
+### Authentication
+
+```typescript
+// Initial connection
+await db.connect('project/db', { anonymous: true });
+
+// Switch to authenticated user
+await db.signIn('new-jwt-token');
+
+// Sign out (become anonymous)
+await db.signOut();
+
+// Listen for auth changes
+db.onAuthStateChanged((auth) => {
+  if (auth) {
+    console.log('Signed in as:', auth.uid);
+  } else {
+    console.log('Signed out');
+  }
+});
+```
+
+## Firebase v8 Compatibility
+
+For users migrating from Firebase who need exact v8 API behavior, use the `fb-v8` sub-package:
+
+```typescript
+import { LarkDatabase, DatabaseReference } from '@lark-sh/client/fb-v8';
+
+const db = new LarkDatabase();
+await db.connect('project/database', { anonymous: true });
+
+const ref = db.ref('players');
 
-- Firebase v8-style API (`ref()`, `set()`, `on()`, `once()`, etc.)
-- Real-time subscriptions with `on()` / `off()`
-- Works in browsers and Node.js
-- TypeScript support
-- `onDisconnect()` handlers for presence
+// Firebase v8 style: on() returns the callback (not unsubscribe)
+const callback = ref.on('value', (snap) => console.log(snap.val()));
+
+// Remove by callback reference
+ref.off('value', callback);
+
+// Context binding
+ref.on('value', this.handleValue, this);
+ref.off('value', this.handleValue, this);
+
+// once() with callbacks
+ref.once('value', successCallback, cancelCallback, context);
+```
+
+**Differences from modern API:**
+| Feature | Modern API | fb-v8 |
+|---------|------------|-------|
+| `on()` return | Unsubscribe function | The callback |
+| `off()` | Optional | Required for cleanup |
+| Context param | Not supported | Supported |
+
+## Transport Options
+
+Lark automatically uses WebTransport when available (Chrome 97+, Edge 97+, Firefox 114+), falling back to WebSocket for Safari and Node.js.
+
+```typescript
+await db.connect('project/db', {
+  anonymous: true,
+  transport: 'auto',           // Default: try WebTransport first
+  // transport: 'websocket',   // Force WebSocket
+  // transport: 'webtransport' // Force WebTransport
+});
+
+// Check which transport is in use
+console.log(db.transportType);  // 'websocket' | 'webtransport'
+```
+
+## Server Time
+
+```typescript
+import { ServerValue } from '@lark-sh/client';
+
+// Use server timestamp
+await db.ref('messages').push({
+  text: 'Hello',
+  createdAt: ServerValue.TIMESTAMP,
+});
+
+// Get server time offset
+const offset = db.serverTimeOffset;  // ms difference from local time
+```
+
+## Error Handling
+
+```typescript
+import { LarkError } from '@lark-sh/client';
+
+try {
+  await db.ref('protected').set({ data: 'test' });
+} catch (err) {
+  if (err instanceof LarkError) {
+    console.log(err.code);    // 'permission_denied', 'not_connected', etc.
+    console.log(err.message);
+  }
+}
+```
 
 ## License
 
-MIT
+Apache-2.0