@lark-sh/client 0.1.16 → 0.1.17

package/dist/fb-v8/index.mjs

@@ -7,7 +7,7 @@ import {
   ServerValue,
   generatePushId,
   isVolatilePath
-} from "../chunk-CYCSP6TZ.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
@@ -357,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
@@ -422,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 {
@@ -478,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;
     /**
@@ -516,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;
     /**
@@ -570,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)
@@ -711,7 +706,7 @@ declare class LarkDatabase {
     private _state;
     private _auth;
     private _databaseId;
-    private _coordinatorUrl;
+    private _domain;
     private _volatilePaths;
     private _transportType;
     private _currentToken;
@@ -789,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>;
     /**
@@ -871,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',
@@ -1145,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)
@@ -1156,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
@@ -357,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
@@ -422,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 {
@@ -478,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;
     /**
@@ -516,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;
     /**
@@ -570,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)
@@ -711,7 +706,7 @@ declare class LarkDatabase {
     private _state;
     private _auth;
     private _databaseId;
-    private _coordinatorUrl;
+    private _domain;
     private _volatilePaths;
     private _transportType;
     private _currentToken;
@@ -789,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>;
     /**
@@ -871,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',
@@ -1145,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)
@@ -1156,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.js

@@ -43,62 +43,6 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
-// src/protocol/constants.ts
-var OnDisconnectAction = {
-  SET: "s",
-  UPDATE: "u",
-  DELETE: "d",
-  CANCEL: "c"
-};
-var ErrorCode = {
-  PERMISSION_DENIED: "permission_denied",
-  INVALID_DATA: "invalid_data",
-  NOT_FOUND: "not_found",
-  INVALID_PATH: "invalid_path",
-  INVALID_OPERATION: "invalid_operation",
-  INTERNAL_ERROR: "internal_error",
-  CONDITION_FAILED: "condition_failed",
-  INVALID_QUERY: "invalid_query",
-  AUTH_REQUIRED: "auth_required"
-};
-var DEFAULT_COORDINATOR_URL = "https://db.lark.sh";
-
-// src/connection/Coordinator.ts
-var Coordinator = class {
-  constructor(baseUrl = DEFAULT_COORDINATOR_URL) {
-    this.baseUrl = baseUrl.replace(/\/$/, "");
-  }
-  /**
-   * Request connection details from the coordinator.
-   *
-   * @param database - Database ID in format "project/database"
-   * @returns Connection details including WebSocket URL and UDP host/port
-   */
-  async connect(database) {
-    const body = { database };
-    const response = await fetch(`${this.baseUrl}/connect`, {
-      method: "POST",
-      headers: {
-        "Content-Type": "application/json"
-      },
-      body: JSON.stringify(body)
-    });
-    if (!response.ok) {
-      let errorMessage = `Coordinator request failed: ${response.status}`;
-      try {
-        const errorBody = await response.json();
-        if (errorBody.message) {
-          errorMessage = errorBody.message;
-        }
-      } catch {
-      }
-      throw new Error(errorMessage);
-    }
-    const data = await response.json();
-    return data;
-  }
-};
-
 // src/connection/WebSocketTransport.ts
 var import_ws = __toESM(require("ws"));
 var WebSocketImpl = typeof WebSocket !== "undefined" ? WebSocket : import_ws.default;
@@ -1465,7 +1409,6 @@ var View = class {
   /**
    * Check if this View loads all data (no limits, no range filters).
    * A View that loads all data can serve as a "complete" cache for child paths.
-   * This matches Firebase's loadsAllData() semantics.
    */
   loadsAllData() {
     if (!this.queryParams) return true;
@@ -1881,8 +1824,8 @@ var SubscriptionManager = class {
   /**
    * Detect and fire child_moved events for children that changed position OR sort value.
    *
-   * Firebase fires child_moved for ANY priority/sort value change, regardless of whether
-   * the position actually changes. This is Case 2003 behavior.
+   * child_moved fires for ANY priority/sort value change, regardless of whether
+   * the position actually changes.
    *
    * IMPORTANT: child_moved should only fire for children whose VALUE or PRIORITY changed.
    * Children that are merely "displaced" by another child moving should NOT fire child_moved.
@@ -2085,9 +2028,6 @@ var SubscriptionManager = class {
    * A complete View has no limits and no range filters, so it contains all data
    * for its subtree. Child subscriptions can use the ancestor's data instead
    * of creating their own server subscription.
-   *
-   * This matches Firebase's behavior where child listeners don't need their own
-   * server subscription if an ancestor has an unlimited listener.
    */
   hasAncestorCompleteView(path) {
     const normalized = normalizePath(path);
@@ -2213,8 +2153,8 @@ var SubscriptionManager = class {
   /**
    * Recursively sort object keys for consistent comparison.
    * This ensures {a:1, b:2} and {b:2, a:1} compare as equal.
-   * Uses simple alphabetical sorting (not Firebase key sorting) since we're
-   * just checking data equality, not display order.
+   * Uses simple alphabetical sorting since we're just checking data equality,
+   * not display order.
    */
   sortKeysForComparison(value) {
     if (value === null || typeof value !== "object") {
@@ -2808,6 +2748,26 @@ var SubscriptionManager = class {
   }
 };
 
+// src/protocol/constants.ts
+var OnDisconnectAction = {
+  SET: "s",
+  UPDATE: "u",
+  DELETE: "d",
+  CANCEL: "c"
+};
+var ErrorCode = {
+  PERMISSION_DENIED: "permission_denied",
+  INVALID_DATA: "invalid_data",
+  NOT_FOUND: "not_found",
+  INVALID_PATH: "invalid_path",
+  INVALID_OPERATION: "invalid_operation",
+  INTERNAL_ERROR: "internal_error",
+  CONDITION_FAILED: "condition_failed",
+  INVALID_QUERY: "invalid_query",
+  AUTH_REQUIRED: "auth_required"
+};
+var DEFAULT_LARK_DOMAIN = "larkdb.net";
+
 // src/OnDisconnect.ts
 var OnDisconnect = class {
   constructor(db, path) {
@@ -3105,7 +3065,6 @@ var DatabaseReference = 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() {
     if (Object.keys(this._query).length === 0) {
@@ -3130,7 +3089,7 @@ var DatabaseReference = 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() {
     const queryObj = {};
@@ -3189,7 +3148,7 @@ var DatabaseReference = class _DatabaseReference {
   }
   /**
    * 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.
    */
   async get() {
     return this.once("value");
@@ -3228,7 +3187,7 @@ var DatabaseReference = 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
@@ -3309,7 +3268,7 @@ var DatabaseReference = 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
@@ -4069,9 +4028,9 @@ var DataSnapshot = 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) {
     const childPath = joinPath(this._path, path);
@@ -4175,7 +4134,6 @@ var DataSnapshot = class _DataSnapshot {
   }
   /**
    * Check if this snapshot was from a volatile (high-frequency) update.
-   * This is a Lark extension not present in Firebase.
    */
   isVolatile() {
     return this._volatile;
@@ -4184,7 +4142,6 @@ var DataSnapshot = class _DataSnapshot {
    * 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() {
     return this._serverTimestamp;
@@ -4307,7 +4264,7 @@ var LarkDatabase = class {
     this._state = "disconnected";
     this._auth = null;
     this._databaseId = null;
-    this._coordinatorUrl = null;
+    this._domain = null;
     this._volatilePaths = [];
     this._transportType = null;
     // Auth state
@@ -4370,8 +4327,9 @@ var LarkDatabase = class {
    * @internal Get the base URL for reference toString().
    */
   _getBaseUrl() {
-    if (this._coordinatorUrl && this._databaseId) {
-      return `${this._coordinatorUrl}/${this._databaseId}`;
+    if (this._domain && this._databaseId) {
+      const projectId = this._databaseId.split("/")[0];
+      return `https://${projectId}.${this._domain}`;
     }
     return "lark://";
   }
@@ -4423,7 +4381,7 @@ var LarkDatabase = class {
    * 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)
    */
   async connect(databaseId, options = {}) {
     if (this._state !== "disconnected") {
@@ -4447,16 +4405,17 @@ var LarkDatabase = class {
     const previousState = this._state;
     this._state = isReconnect ? "reconnecting" : "connecting";
     this._databaseId = databaseId;
-    this._coordinatorUrl = options.coordinator || DEFAULT_COORDINATOR_URL;
+    this._domain = options.domain || DEFAULT_LARK_DOMAIN;
     if (!isReconnect) {
       this._currentToken = options.token || "";
       this._isAnonymous = !options.token && options.anonymous !== false;
     }
     try {
-      const coordinatorUrl = this._coordinatorUrl;
-      const coordinator = new Coordinator(coordinatorUrl);
-      const connectResponse = await coordinator.connect(databaseId);
-      const wsUrl = connectResponse.ws_url;
+      const projectId = databaseId.split("/")[0];
+      if (!projectId) {
+        throw new Error('Invalid database ID: must be in format "projectId/databaseName"');
+      }
+      const wsUrl = `wss://${projectId}.${this._domain}/ws`;
       const transportResult = await createTransport(
         wsUrl,
         {
@@ -4617,7 +4576,7 @@ var LarkDatabase = class {
     this._auth = null;
     this._databaseId = null;
     this._volatilePaths = [];
-    this._coordinatorUrl = null;
+    this._domain = null;
     this._connectionId = null;
     this._connectOptions = null;
     this._transportType = null;
@@ -4814,7 +4773,7 @@ var LarkDatabase = class {
    *
    * Supports two syntaxes:
    *
-   * **Object syntax** (like Firebase multi-path update):
+   * **Object syntax** (multi-path update):
    * ```javascript
    * await db.transaction({
    *   '/users/alice/name': 'Alice',