js-bao-wss-client 2.0.0 → 2.0.2

package/dist/browser.umd.js

@@ -4603,6 +4603,14 @@
                 if (!response.ok)
                     return false;
                 const config = await response.json();
+                // The browser confidential flow exchanges the code server-side with the
+                // stored client_secret, so gate on `hasWebOAuth` (clientId AND secret),
+                // not `hasOAuth` (which is clientId-only for native PKCE clients). Fall
+                // back to the old check when talking to an older server that doesn't yet
+                // return `hasWebOAuth`.
+                if (typeof config.hasWebOAuth === "boolean") {
+                    return config.hasWebOAuth;
+                }
                 return config.hasOAuth && !!config.googleClientId;
             }
             catch (error) {
@@ -9582,12 +9590,6 @@
             // existing callers (the deprecated public `list`) keep working unchanged.
             const endpoint = internal?.endpoint || "documents";
             const ownerOnly = internal?.ownerOnly === true;
-            // Predicate applied at all three filter sites: local-cache fetch,
-            // network response handling, and merged-result final union. When
-            // `ownerOnly` is false (legacy `documents.list`), this is the identity.
-            const permissionFilter = ownerOnly
-                ? (entry) => entry?.permission === "owner"
-                : null;
             const includeRoot = options?.includeRoot === true;
             const refreshFromServer = options?.localOnly
                 ? false
@@ -9616,6 +9618,23 @@
                     return !isIdRoot && !isRootTagged;
                 });
             };
+            // Issue #875: the root doc's DocumentPermission is `read-write` (never
+            // `owner`), so the defense-in-depth owner filter would re-drop the root
+            // doc the server now returns under `includeRoot`. Exempt it by IDENTITY
+            // (id/tag), mirroring `filterRoot` above. Without this the SDK would still
+            // omit the root from `me.ownedDocuments({ includeRoot: true })`.
+            const isRootEntry = (entry) => {
+                const isIdRoot = rootId ? entry?.documentId === rootId : false;
+                const isRootTagged = Array.isArray(entry?.tags) && entry.tags.includes(ROOT_DOCUMENT_TAG);
+                return isIdRoot || isRootTagged;
+            };
+            // Predicate applied at all three filter sites: local-cache fetch,
+            // network response handling, and merged-result final union. When
+            // `ownerOnly` is false (legacy `documents.list`), this is the identity.
+            const permissionFilter = ownerOnly
+                ? (entry) => entry?.permission === "owner" ||
+                    (includeRoot && isRootEntry(entry))
+                : null;
             // Helper: local metadata -> DocumentInfo-like
             const getLocalMetadataList = async (onlyWithLocalData) => {
                 const items = await this.client.listLocalDocumentsUnified({
@@ -9910,7 +9929,24 @@
                     forward,
                     tag,
                 });
-                firstPage.items = firstPage.items.slice(0, limit);
+                // Issue #875: when `includeRoot` is requested, the server prepends the
+                // user's root doc to page 1 (no incoming cursor) as a singleton OUTSIDE
+                // the `limit` count — so a full page legitimately carries `limit + 1`
+                // rows (`[root, owned1, ..., ownedN]`). A naive `slice(0, limit)` would
+                // drop the LAST owned row while the server cursor has already advanced
+                // past it, permanently skipping that doc on the next page. Mirror the
+                // server's semantics here: keep `limit` OWNED rows plus the root, so the
+                // root never evicts a real owned row. The cursor (which reflects the last
+                // OWNED row emitted, not the root prepend) is left untouched and stays
+                // correct.
+                if (includeRoot && !cursor) {
+                    const rootRows = firstPage.items.filter((it) => isRootEntry(it));
+                    const nonRootRows = firstPage.items.filter((it) => !isRootEntry(it));
+                    firstPage.items = [...rootRows, ...nonRootRows.slice(0, limit)];
+                }
+                else {
+                    firstPage.items = firstPage.items.slice(0, limit);
+                }
                 if (!firstPage.cursor) {
                     firstPage.cursor = undefined; // do not fabricate cursor
                 }
@@ -11650,6 +11686,9 @@
          * @param options.max_tokens - Maximum number of tokens to generate in the response
          * @param options.reasoning - Controls extended thinking behavior (effort level, token budget, visibility)
          * @returns The assistant message with `role`, `content`, optional `annotations`, and `raw` provider response
+         * @deprecated The direct LLM client API is deprecated and will be removed in a
+         * future major release. Use {@link PromptsAPI.execute | client.prompts.execute}
+         * (managed prompts) or a workflow `llm.chat` step instead.
          */
         async chat(options) {
             const analytics = this.getAnalyticsContext();
@@ -11695,7 +11734,11 @@
             }
         }
         /** Lists available LLM models and returns the default model name.
-         * @returns Object with `models` array and `defaultModel` name */
+         * @returns Object with `models` array and `defaultModel` name
+         * @deprecated The direct LLM client API is deprecated and will be removed in a
+         * future major release. Use {@link PromptsAPI.execute | client.prompts.execute}
+         * (managed prompts) or a workflow `llm.chat` step instead.
+         */
         async models() {
             return this.client.makeRequest("GET", "/llm/models");
         }
@@ -11714,6 +11757,9 @@
          * @param options.safety - Safety filter settings that control content blocking thresholds
          * @param options.generationConfig - Low-level generation parameters (temperature, token limits, etc.)
          * @param options.structuredOutput - Constrains the response to a specific MIME type and/or JSON schema
+         * @deprecated The direct Gemini client API is deprecated and will be removed in
+         * a future major release. Use {@link PromptsAPI.execute | client.prompts.execute}
+         * (managed prompts) or a workflow `gemini.generate` step instead.
          */
         async generate(options) {
             const analytics = this.getAnalyticsContext();
@@ -11736,7 +11782,11 @@
             }
         }
         /** Lists available Gemini models and returns the default model name.
-         * @returns Object with `models` array and `defaultModel` name */
+         * @returns Object with `models` array and `defaultModel` name
+         * @deprecated The direct Gemini client API is deprecated and will be removed in
+         * a future major release. Use {@link PromptsAPI.execute | client.prompts.execute}
+         * (managed prompts) or a workflow `gemini.generate` step instead.
+         */
         async models() {
             return this.client.makeRequest("GET", "/gemini/models");
         }
@@ -11750,6 +11800,9 @@
          * @param options.generationConfig - Generation config (included for parity but does not affect counts)
          * @param options.structuredOutput - Structured output config (included for parity but does not affect counts)
          * @returns Object with `totalTokens` count and optional `promptTokens`, `candidates`, and `raw` response
+         * @deprecated The direct Gemini client API is deprecated and will be removed in
+         * a future major release. Use {@link PromptsAPI.execute | client.prompts.execute}
+         * (managed prompts) or a workflow `gemini.generate` step instead.
          */
         async countTokens(options) {
             const analytics = this.getAnalyticsContext();
@@ -11777,6 +11830,9 @@
          * @param options.model - The Gemini model to target (required)
          * @param options.body - The raw JSON payload forwarded directly to the Gemini API
          * @param options.query - Additional query-string parameters appended to the request URL
+         * @deprecated The direct Gemini client API is deprecated and will be removed in
+         * a future major release. Use {@link PromptsAPI.execute | client.prompts.execute}
+         * (managed prompts) or a workflow `gemini.generate` step instead.
          */
         async generateRaw(options) {
             if (!options || typeof options.model !== "string" || !options.model.trim()) {
@@ -12868,6 +12924,14 @@
         async getBucket(bucketIdOrKey) {
             return this.client.makeRequest("GET", `/blob-buckets/${encodeURIComponent(bucketIdOrKey)}`);
         }
+        /**
+         * Update a bucket's access without recreating it (#1020). Admin/owner only.
+         * Change the `preset`, attach/swap/clear a custom `ruleSetId`, or edit
+         * `name`/`description`. Setting a non-custom preset clears any rule set.
+         */
+        async updateBucket(bucketIdOrKey, params) {
+            return this.client.makeRequest("PATCH", `/blob-buckets/${encodeURIComponent(bucketIdOrKey)}`, params);
+        }
         /** Delete a bucket and all blobs inside it. */
         async deleteBucket(bucketIdOrKey) {
             return this.client.makeRequest("DELETE", `/blob-buckets/${encodeURIComponent(bucketIdOrKey)}`);
@@ -13364,7 +13428,6 @@
     }
 
     const DEFAULT_RETURN_ACTIVE_MIN_MS = 5 * 60 * 1000;
-    const DEFAULT_OFFLINE_RECOVERY_MIN_MS = 60 * 1000;
     const DEFAULT_SYNC_ERROR_MIN_MS = 30 * 1000;
     const logger = createLogger({ scope: "JsBaoClient" });
     function debugLog(tag, payload) {
@@ -13566,13 +13629,10 @@
             this.analyticsMetadataUserId = null;
             this.analyticsMetadataHydration = null;
             this.sessionStartAt = Date.now();
-            this.bootEventLogged = false;
-            this.lastOfflineRecoveryAt = 0;
             this.lastSyncErrorEventAt = 0;
             this.blobUploadStartLogged = new Set();
             this.blobUploadSuccessLogged = new Set();
             this.blobUploadFailureLogged = new Set();
-            this.serviceWorkerControlLogged = false;
             this.sessionEndLogged = false;
             this.bootDetectedOffline = false;
             this.authBootstrapPromise = null;
@@ -13722,20 +13782,6 @@
                 analyticsAuto.minResumeMs >= 0
                 ? analyticsAuto.minResumeMs
                 : DEFAULT_RETURN_ACTIVE_MIN_MS;
-            const offlineRecoveryOption = analyticsAuto.offlineRecovery;
-            const offlineRecoveryEnabled = offlineRecoveryOption === undefined
-                ? true
-                : typeof offlineRecoveryOption === "boolean"
-                    ? offlineRecoveryOption
-                    : offlineRecoveryOption?.enabled !== false;
-            const offlineRecoveryMinMs = offlineRecoveryOption &&
-                typeof offlineRecoveryOption === "object" &&
-                offlineRecoveryOption !== null &&
-                typeof offlineRecoveryOption.minIntervalMs === "number" &&
-                Number.isFinite(offlineRecoveryOption.minIntervalMs) &&
-                offlineRecoveryOption.minIntervalMs >= 0
-                ? offlineRecoveryOption.minIntervalMs
-                : DEFAULT_OFFLINE_RECOVERY_MIN_MS;
             const syncErrorsOption = analyticsAuto.syncErrors;
             const syncErrorsEnabled = syncErrorsOption === undefined
                 ? true
@@ -13792,31 +13838,10 @@
                     geminiFailure = geminiOption.failure !== false;
                 }
             }
-            const serviceWorkerOption = analyticsAuto.serviceWorker;
-            let serviceWorkerControl = true;
-            let serviceWorkerTokenUpdate = true;
-            if (serviceWorkerOption !== undefined) {
-                if (typeof serviceWorkerOption === "boolean") {
-                    serviceWorkerControl = serviceWorkerOption;
-                    serviceWorkerTokenUpdate = serviceWorkerOption;
-                }
-                else if (typeof serviceWorkerOption === "object" &&
-                    serviceWorkerOption !== null) {
-                    serviceWorkerControl = serviceWorkerOption.control !== false;
-                    serviceWorkerTokenUpdate = serviceWorkerOption.tokenUpdate !== false;
-                }
-            }
             this.analyticsAutoEventsConfig = {
                 dailyAuth: analyticsAuto.dailyAuth !== false,
                 returnActive: analyticsAuto.returnActive !== false,
                 minResumeMs,
-                boot: analyticsAuto.boot !== false,
-                firstDocOpen: analyticsAuto.firstDocOpen !== false,
-                firstDocEdit: analyticsAuto.firstDocEdit !== false,
-                offlineRecovery: {
-                    enabled: offlineRecoveryEnabled,
-                    minIntervalMs: offlineRecoveryMinMs,
-                },
                 syncErrors: {
                     enabled: syncErrorsEnabled,
                     minIntervalMs: syncErrorsMinMs,
@@ -13836,10 +13861,6 @@
                     success: geminiSuccess,
                     failure: geminiFailure,
                 },
-                serviceWorker: {
-                    control: serviceWorkerControl,
-                    tokenUpdate: serviceWorkerTokenUpdate,
-                },
                 sessionEnd: analyticsAuto.sessionEnd !== false,
             };
             this.offlineStore = new OfflineStore(logger);
@@ -13930,7 +13951,6 @@
                 },
                 uploadConcurrency: options.blobUploadConcurrency,
             });
-            this.on("documentOpened", (payload) => this.handleDocumentOpenedForAnalytics(payload));
             this.on("blobs:upload-progress", (payload) => this.handleBlobUploadProgress(payload));
             this.on("blobs:upload-completed", (payload) => this.handleBlobUploadComplete(payload));
             this.on("blobs:upload-failed", (payload) => this.handleBlobUploadFailed(payload));
@@ -14185,7 +14205,6 @@
                     }
                 };
             }
-            this.logBootEvent();
             logger.log(`Initializing client for app ${options.appId}`);
             // Initialize KV cache and public cache API facade
             try {
@@ -15668,8 +15687,12 @@
                 status = "apply_pending";
             else if (dbStatus === "apply_claimed")
                 status = "apply_claimed";
+            // Normalize the raw Cloudflare success spelling "complete" to the
+            // canonical "completed" used by the workflowStatus event, runSync, and
+            // the persisted run.status (issue #967). This matches the server's own
+            // mapInstanceStatus helper.
             else if (cfStatus === "complete")
-                status = "complete";
+                status = "completed";
             else if (cfStatus === "errored")
                 status = "failed";
             else if (cfStatus === "terminated")
@@ -15701,8 +15724,11 @@
             const rawStatus = response?.status;
             const cfStatus = String(rawStatus?.status || "").toLowerCase();
             let status;
+            // Normalize the raw Cloudflare success spelling "complete" to the
+            // canonical "completed" (issue #967), consistent with getStatus and the
+            // workflowStatus event.
             if (cfStatus === "complete")
-                status = "complete";
+                status = "completed";
             else if (cfStatus === "errored")
                 status = "failed";
             else if (cfStatus === "terminated")
@@ -16041,10 +16067,6 @@
             if (!this.isServiceWorkerBridgeEnvironment())
                 return;
             this.serviceWorkerBridgePendingMessages.set(type, payload);
-            if (type === "jsBao:tokenUpdated") {
-                const safePayload = payload && typeof payload === "object" ? { cause: payload.cause } : undefined;
-                this.logServiceWorkerTokenUpdate(safePayload);
-            }
             this.flushServiceWorkerBridgeMessages();
         }
         flushServiceWorkerBridgeMessages() {
@@ -16057,7 +16079,6 @@
                 this.ensureServiceWorkerControllerListener();
                 return;
             }
-            this.logServiceWorkerControl();
             if (this.serviceWorkerBridgeInitPayload &&
                 !this.serviceWorkerBridgePendingMessages.has("jsBao:init")) {
                 this.serviceWorkerBridgePendingMessages.set("jsBao:init", this.serviceWorkerBridgeInitPayload);
@@ -16223,7 +16244,6 @@
             this.analyticsMetadataUserId = null;
         }
         resetSessionAutoEventState() {
-            this.lastOfflineRecoveryAt = 0;
             this.lastSyncErrorEventAt = 0;
             this.blobUploadStartLogged.clear();
             this.blobUploadSuccessLogged.clear();
@@ -16369,19 +16389,6 @@
                 logger.warn("[analytics] return-active auto-event error", err);
             });
         }
-        logBootEvent() {
-            // Removed: client_boot fires before auth completes so it has no user.
-            // Listen for first user_active_daily instead.
-        }
-        handleDocumentOpenedForAnalytics(_event) {
-            // Removed: low value; apps can log their own document events.
-        }
-        maybeLogFirstDocEdit(_documentId) {
-            // Removed: low value; apps can log their own document events.
-        }
-        maybeLogOfflineRecoveryEvent(_source) {
-            // Removed: rare edge case, not actionable.
-        }
         maybeLogSyncErrorEvent(documentId, reason) {
             const config = this.analyticsAutoEventsConfig.syncErrors;
             if (!config.enabled)
@@ -16457,13 +16464,6 @@
                 },
             });
         }
-        logServiceWorkerControl() {
-            // TODO: log service_worker_control in an admin-facing analytics system
-            // (fires before/without auth — no user context available)
-        }
-        logServiceWorkerTokenUpdate(_payload) {
-            // Removed: internal implementation detail.
-        }
         logSessionEndEvent(reason) {
             if (!this.analyticsAutoEventsConfig.sessionEnd || this.sessionEndLogged) {
                 return;
@@ -16710,7 +16710,6 @@
             });
         }
         enqueueLocalUpdate(documentId, update) {
-            this.maybeLogFirstDocEdit(documentId);
             const existing = this.pendingLocalUpdates.get(documentId);
             const updateCopy = new Uint8Array(update); // clone to avoid accidental mutation
             if (existing) {
@@ -20017,9 +20016,6 @@
                     }, this.buildCommitRetryContext());
                 }
                 catch (_) { }
-                if (previousMode === "offline") {
-                    this.maybeLogOfflineRecoveryEvent("setNetworkMode");
-                }
             }
             else {
                 // auto: if we have a token, allow connect/reconnect