@lark-sh/client 0.1.15 → 0.1.17

package/dist/fb-v8/index.mjs

@@ -7,7 +7,7 @@ import {
   ServerValue,
   generatePushId,
   isVolatilePath
-} from "../chunk-EK7OYLDG.mjs";
+} from "../chunk-VLAAYUVX.mjs";
 
 // src/fb-v8/index.ts
 var DatabaseReference = class _DatabaseReference {

package/dist/index.d.mts

@@ -106,7 +106,6 @@ declare class DatabaseReference {
      * For queries (created via orderBy*, limitTo*, startAt, etc.), this returns
      * a reference to the same path without query constraints.
      * For non-query references, this returns the reference itself.
-     * This matches Firebase's Query.ref behavior.
      */
     get ref(): DatabaseReference;
     /**
@@ -121,12 +120,12 @@ declare class DatabaseReference {
      * Returns "default" for non-query references (no constraints).
      * Returns a sorted JSON string of wire-format params for queries.
      *
-     * This matches Firebase's queryIdentifier format for wire compatibility.
+     * Used for wire protocol and subscription deduplication.
      */
     get queryIdentifier(): string;
     /**
      * Get the data at this location. Alias for once('value').
-     * This is Firebase's newer API for reading data.
+     * Alternative to once('value') for reading data.
      */
     get(): Promise<DataSnapshot>;
     /**
@@ -145,7 +144,7 @@ declare class DatabaseReference {
     /**
      * Update specific children at this location without overwriting other children.
      *
-     * Also supports Firebase-style multi-path updates when keys look like paths
+     * Also supports multi-path updates when keys look like paths
      * (start with '/'). In this mode, each path is written atomically as a transaction.
      *
      * @example
@@ -201,7 +200,7 @@ declare class DatabaseReference {
      * For objects: injects `.priority` into the value object.
      * For primitives: wraps as `{ '.value': primitive, '.priority': priority }`.
      *
-     * This follows Firebase's wire format for primitives with priority.
+     * Uses { '.value': value, '.priority': priority } format for the wire protocol.
      *
      * @param value - The value to write
      * @param priority - The priority for ordering
@@ -335,9 +334,8 @@ declare class DatabaseReference {
      */
     private _validateQueryValue;
     /**
-     * Validate that a key is a valid Firebase key format.
-     * Invalid characters: . $ # [ ] /
-     * Also cannot start or end with .
+     * Validate that a key is a valid key format.
+     * Delegates to the shared validation utility.
      */
     private _validateKeyFormat;
     /**
@@ -358,7 +356,7 @@ declare class DatabaseReference {
 /**
  * A reference that is also a Promise - returned by push().
  *
- * This allows Firebase-compatible patterns like:
+ * This allows patterns like:
  * ```javascript
  * const pushed = ref.push();
  * console.log(pushed.key); // Key available immediately
@@ -423,12 +421,10 @@ type TxOperation = TxSetOp | TxUpdateOp | TxDeleteOp | TxConditionOp;
  * - Priority is stored as a regular child value `.priority` in the data
  * - val() strips `.priority` from returned objects (so app code doesn't see it)
  * - getPriority() reads from the data's `.priority` field
- * - This matches Firebase behavior where priority is metadata, not user data
  *
  * Wrapped Primitives:
  * - Primitives with priority are stored as `{ '.value': x, '.priority': y }`
  * - val() automatically unwraps these to return just the primitive value
- * - This follows Firebase's wire format for primitives with priority
  */
 
 declare class DataSnapshot {
@@ -479,9 +475,9 @@ declare class DataSnapshot {
      * Get a child snapshot at the specified path.
      *
      * Special handling:
-     * - `.priority` returns the priority value (Firebase compatible)
+     * - `.priority` returns the priority value
      * - For wrapped primitives, only `.priority` returns data; other paths return null
-     * - Non-existent paths return a snapshot with val() === null (Firebase compatible)
+     * - Non-existent paths return a snapshot with val() === null
      */
     child(path: string): DataSnapshot;
     /**
@@ -517,14 +513,12 @@ declare class DataSnapshot {
     getPriority(): number | string | null;
     /**
      * Check if this snapshot was from a volatile (high-frequency) update.
-     * This is a Lark extension not present in Firebase.
      */
     isVolatile(): boolean;
     /**
      * Get the server timestamp for this snapshot (milliseconds since Unix epoch).
      * Only present on volatile value events. Use deltas between timestamps for
      * interpolation rather than absolute times to avoid clock sync issues.
-     * This is a Lark extension not present in Firebase.
      */
     getServerTimestamp(): number | null;
     /**
@@ -571,8 +565,8 @@ interface ConnectOptions {
     token?: string;
     /** Connect anonymously (server assigns a UID) */
     anonymous?: boolean;
-    /** Coordinator URL (default: https://db.lark.dev) */
-    coordinator?: string;
+    /** Lark domain (default: larkdb.net) */
+    domain?: string;
     /**
      * Transport type preference.
      * - 'auto': Try WebTransport first, fall back to WebSocket (default)
@@ -712,7 +706,7 @@ declare class LarkDatabase {
     private _state;
     private _auth;
     private _databaseId;
-    private _coordinatorUrl;
+    private _domain;
     private _volatilePaths;
     private _transportType;
     private _currentToken;
@@ -790,7 +784,7 @@ declare class LarkDatabase {
      * Connect to a database.
      *
      * @param databaseId - Database ID in format "project/database"
-     * @param options - Connection options (token, anonymous, coordinator URL)
+     * @param options - Connection options (token, anonymous, domain)
      */
     connect(databaseId: string, options?: ConnectOptions): Promise<void>;
     /**
@@ -872,7 +866,7 @@ declare class LarkDatabase {
      *
      * Supports two syntaxes:
      *
-     * **Object syntax** (like Firebase multi-path update):
+     * **Object syntax** (multi-path update):
      * ```javascript
      * await db.transaction({
      *   '/users/alice/name': 'Alice',
@@ -1146,7 +1140,7 @@ declare class PendingWriteManager {
 }
 
 /**
- * Push ID generation - Firebase-compatible chronologically-sortable IDs.
+ * Push ID generation - chronologically-sortable unique IDs.
  *
  * Format: 20 characters
  * - First 8 chars: timestamp (milliseconds since epoch, base64-encoded)
@@ -1157,7 +1151,7 @@ declare class PendingWriteManager {
  * - IDs created in the same millisecond are unique and still sort correctly
  */
 /**
- * Generate a Firebase-compatible push ID.
+ * Generate a unique push ID.
  */
 declare function generatePushId(): string;
 

package/dist/index.d.ts

@@ -106,7 +106,6 @@ declare class DatabaseReference {
      * For queries (created via orderBy*, limitTo*, startAt, etc.), this returns
      * a reference to the same path without query constraints.
      * For non-query references, this returns the reference itself.
-     * This matches Firebase's Query.ref behavior.
      */
     get ref(): DatabaseReference;
     /**
@@ -121,12 +120,12 @@ declare class DatabaseReference {
      * Returns "default" for non-query references (no constraints).
      * Returns a sorted JSON string of wire-format params for queries.
      *
-     * This matches Firebase's queryIdentifier format for wire compatibility.
+     * Used for wire protocol and subscription deduplication.
      */
     get queryIdentifier(): string;
     /**
      * Get the data at this location. Alias for once('value').
-     * This is Firebase's newer API for reading data.
+     * Alternative to once('value') for reading data.
      */
     get(): Promise<DataSnapshot>;
     /**
@@ -145,7 +144,7 @@ declare class DatabaseReference {
     /**
      * Update specific children at this location without overwriting other children.
      *
-     * Also supports Firebase-style multi-path updates when keys look like paths
+     * Also supports multi-path updates when keys look like paths
      * (start with '/'). In this mode, each path is written atomically as a transaction.
      *
      * @example
@@ -201,7 +200,7 @@ declare class DatabaseReference {
      * For objects: injects `.priority` into the value object.
      * For primitives: wraps as `{ '.value': primitive, '.priority': priority }`.
      *
-     * This follows Firebase's wire format for primitives with priority.
+     * Uses { '.value': value, '.priority': priority } format for the wire protocol.
      *
      * @param value - The value to write
      * @param priority - The priority for ordering
@@ -335,9 +334,8 @@ declare class DatabaseReference {
      */
     private _validateQueryValue;
     /**
-     * Validate that a key is a valid Firebase key format.
-     * Invalid characters: . $ # [ ] /
-     * Also cannot start or end with .
+     * Validate that a key is a valid key format.
+     * Delegates to the shared validation utility.
      */
     private _validateKeyFormat;
     /**
@@ -358,7 +356,7 @@ declare class DatabaseReference {
 /**
  * A reference that is also a Promise - returned by push().
  *
- * This allows Firebase-compatible patterns like:
+ * This allows patterns like:
  * ```javascript
  * const pushed = ref.push();
  * console.log(pushed.key); // Key available immediately
@@ -423,12 +421,10 @@ type TxOperation = TxSetOp | TxUpdateOp | TxDeleteOp | TxConditionOp;
  * - Priority is stored as a regular child value `.priority` in the data
  * - val() strips `.priority` from returned objects (so app code doesn't see it)
  * - getPriority() reads from the data's `.priority` field
- * - This matches Firebase behavior where priority is metadata, not user data
  *
  * Wrapped Primitives:
  * - Primitives with priority are stored as `{ '.value': x, '.priority': y }`
  * - val() automatically unwraps these to return just the primitive value
- * - This follows Firebase's wire format for primitives with priority
  */
 
 declare class DataSnapshot {
@@ -479,9 +475,9 @@ declare class DataSnapshot {
      * Get a child snapshot at the specified path.
      *
      * Special handling:
-     * - `.priority` returns the priority value (Firebase compatible)
+     * - `.priority` returns the priority value
      * - For wrapped primitives, only `.priority` returns data; other paths return null
-     * - Non-existent paths return a snapshot with val() === null (Firebase compatible)
+     * - Non-existent paths return a snapshot with val() === null
      */
     child(path: string): DataSnapshot;
     /**
@@ -517,14 +513,12 @@ declare class DataSnapshot {
     getPriority(): number | string | null;
     /**
      * Check if this snapshot was from a volatile (high-frequency) update.
-     * This is a Lark extension not present in Firebase.
      */
     isVolatile(): boolean;
     /**
      * Get the server timestamp for this snapshot (milliseconds since Unix epoch).
      * Only present on volatile value events. Use deltas between timestamps for
      * interpolation rather than absolute times to avoid clock sync issues.
-     * This is a Lark extension not present in Firebase.
      */
     getServerTimestamp(): number | null;
     /**
@@ -571,8 +565,8 @@ interface ConnectOptions {
     token?: string;
     /** Connect anonymously (server assigns a UID) */
     anonymous?: boolean;
-    /** Coordinator URL (default: https://db.lark.dev) */
-    coordinator?: string;
+    /** Lark domain (default: larkdb.net) */
+    domain?: string;
     /**
      * Transport type preference.
      * - 'auto': Try WebTransport first, fall back to WebSocket (default)
@@ -712,7 +706,7 @@ declare class LarkDatabase {
     private _state;
     private _auth;
     private _databaseId;
-    private _coordinatorUrl;
+    private _domain;
     private _volatilePaths;
     private _transportType;
     private _currentToken;
@@ -790,7 +784,7 @@ declare class LarkDatabase {
      * Connect to a database.
      *
      * @param databaseId - Database ID in format "project/database"
-     * @param options - Connection options (token, anonymous, coordinator URL)
+     * @param options - Connection options (token, anonymous, domain)
      */
     connect(databaseId: string, options?: ConnectOptions): Promise<void>;
     /**
@@ -872,7 +866,7 @@ declare class LarkDatabase {
      *
      * Supports two syntaxes:
      *
-     * **Object syntax** (like Firebase multi-path update):
+     * **Object syntax** (multi-path update):
      * ```javascript
      * await db.transaction({
      *   '/users/alice/name': 'Alice',
@@ -1146,7 +1140,7 @@ declare class PendingWriteManager {
 }
 
 /**
- * Push ID generation - Firebase-compatible chronologically-sortable IDs.
+ * Push ID generation - chronologically-sortable unique IDs.
  *
  * Format: 20 characters
  * - First 8 chars: timestamp (milliseconds since epoch, base64-encoded)
@@ -1157,7 +1151,7 @@ declare class PendingWriteManager {
  * - IDs created in the same millisecond are unique and still sort correctly
  */
 /**
- * Generate a Firebase-compatible push ID.
+ * Generate a unique push ID.
  */
 declare function generatePushId(): string;