@rapidmx/activesync 1.0.0-beta.0

package/dist/lib/commands/FolderSyncCommand.js

@@ -0,0 +1,150 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz. All rights reserved.
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+import { ApiError, ObjectDecorators } from "@rapidrest/core";
+import { ApiErrorMessages, ApiErrors, RepoUtils } from "@rapidrest/service-core";
+import { WbxmlCodePage } from "../codec/WbxmlCodePages.js";
+import { childText, element, textElement } from "../codec/WbxmlElement.js";
+import { computeChanges, formatSyncKey, persistDeviceSyncState, resolveSyncKey } from "../EasSyncKeyUtils.js";
+import { FolderType } from "@rapidmx/restapi";
+const { Config, Init } = ObjectDecorators;
+/** Maps this library's `FolderType` to the closest MS-ASCMD folder type code. Several of this app's types
+ * collapse onto the spec's "default well-known folder" codes rather than distinguishing a default folder from
+ * a second, user-created folder of the same content type (e.g. a second calendar also reports as `8`) - a
+ * deliberate pragmatic-subset simplification, not an oversight; see `BaseFolderRoute`'s own precedent for
+ * this library's general stance on this kind of gap. */
+const FOLDER_TYPE_CODES = {
+    [FolderType.INBOX]: "2",
+    [FolderType.DRAFTS]: "3",
+    [FolderType.DELETED_ITEMS]: "4",
+    [FolderType.SENT_ITEMS]: "5",
+    [FolderType.OUTBOX]: "6",
+    [FolderType.TASKS]: "7",
+    [FolderType.CALENDAR]: "8",
+    [FolderType.CONTACTS]: "9",
+    [FolderType.NOTES]: "10",
+    [FolderType.JUNK]: "12",
+    [FolderType.USER]: "12",
+};
+/** EAS represents "no parent" (a top-level folder) as the literal string `"0"`, not an absent element. */
+const ROOT_PARENT_ID = "0";
+/** The (somewhat arbitrary, since `FolderSync` covers the whole mailbox's folder hierarchy rather than one
+ * particular folder) key `DeviceSyncState.folderSyncKeys` is stored under for this cursor - distinct from any
+ * real `Folder.uid`, which is exactly why using the mailbox's own uid here would be ambiguous. */
+const FOLDER_HIERARCHY_CURSOR_KEY = "$foldersync";
+/** Caps how many folder changes are enumerated per round - real mailboxes rarely have more than a few dozen
+ * folders, so this is generous, not a real-world binding constraint; it exists so `computeChanges()`'s
+ * `MoreAvailable` mechanism is exercised the same way it will be for `SyncCommand`'s much larger item
+ * collections. */
+const DEFAULT_WINDOW_SIZE = 512;
+/**
+ * Handles EAS `FolderSync`: enumerates `Add`/`Update`/`Delete`s for the caller's mailbox's `Folder` hierarchy
+ * since the device's last `FolderSync`, using the shared watermark-based cursor mechanism in
+ * `EasSyncKeyUtils.ts` (scoped by `mailboxUid` over the `Folder` collection, rather than `folderUid` over a
+ * per-folder item collection the way `SyncCommand` will be).
+ *
+ * `folderClass` is supplied by the Mongo/SQL concrete subclasses, following the exact one-line-per-backend
+ * pattern used throughout this library's other routes/jobs.
+ *
+ * @author Jean-Philippe Steinmetz
+ */
+export class FolderSyncCommand {
+    constructor() {
+        this.command = "FolderSync";
+        this.windowSize = DEFAULT_WINDOW_SIZE;
+    }
+    async init() {
+        this.folderRepo = await this._objectFactory.newInstance(RepoUtils, {
+            name: this.folderClass.name,
+            args: [this.folderClass],
+        });
+    }
+    async handle(ctx) {
+        if (!this.folderRepo) {
+            throw new ApiError(ApiErrors.INTERNAL_ERROR, 500, ApiErrorMessages.INTERNAL_ERROR);
+        }
+        const clientSyncKey = ctx.request ? childText(ctx.request, "SyncKey") : undefined;
+        const storedSyncKey = ctx.deviceSyncState.folderSyncKeys[FOLDER_HIERARCHY_CURSOR_KEY];
+        const resolution = resolveSyncKey(clientSyncKey, storedSyncKey);
+        if (resolution.kind === "invalid") {
+            return element(WbxmlCodePage.FolderHierarchy, "FolderSync", [
+                textElement(WbxmlCodePage.FolderHierarchy, "Status", "3"),
+            ]);
+        }
+        if (resolution.kind === "initial") {
+            // Per spec: the first response to SyncKey "0" never returns items itself, only establishes a
+            // cursor - but that cursor's watermark must be the epoch, not "now": the client's *next* request
+            // (with this key) is its true first full sync and must report every existing folder as an Add,
+            // including ones that existed and were last modified long before this handshake ever started.
+            // Watermarking at "now" here would silently skip all of those (an epoch-old folder never appears
+            // as "modified after now"), which is exactly backwards for a brand-new device's first sync.
+            const newKey = formatSyncKey({ generation: 1, watermark: new Date(0) });
+            await this.persistSyncKey(ctx, newKey);
+            return element(WbxmlCodePage.FolderHierarchy, "FolderSync", [
+                textElement(WbxmlCodePage.FolderHierarchy, "Status", "1"),
+                textElement(WbxmlCodePage.FolderHierarchy, "SyncKey", newKey),
+            ]);
+        }
+        const changes = await computeChanges(this.folderRepo, "mailboxUid", ctx.mailboxUid, resolution.key.watermark, this.windowSize);
+        const newKey = formatSyncKey({ generation: resolution.key.generation + 1, watermark: changes.newWatermark });
+        await this.persistSyncKey(ctx, newKey);
+        const totalChanges = changes.adds.length + changes.changes.length + changes.deletes.length;
+        if (totalChanges === 0) {
+            return element(WbxmlCodePage.FolderHierarchy, "FolderSync", [
+                textElement(WbxmlCodePage.FolderHierarchy, "Status", "1"),
+                textElement(WbxmlCodePage.FolderHierarchy, "SyncKey", newKey),
+            ]);
+        }
+        const changeElements = [
+            ...changes.adds.map((folder) => this.folderToChangeElement("Add", folder)),
+            ...changes.changes.map((folder) => this.folderToChangeElement("Update", folder)),
+            ...changes.deletes.map((folder) => element(WbxmlCodePage.FolderHierarchy, "Delete", [
+                textElement(WbxmlCodePage.FolderHierarchy, "ServerId", folder.uid),
+            ])),
+        ];
+        return element(WbxmlCodePage.FolderHierarchy, "FolderSync", [
+            textElement(WbxmlCodePage.FolderHierarchy, "Status", "1"),
+            textElement(WbxmlCodePage.FolderHierarchy, "SyncKey", newKey),
+            element(WbxmlCodePage.FolderHierarchy, "Changes", [
+                textElement(WbxmlCodePage.FolderHierarchy, "Count", String(totalChanges)),
+                ...changeElements,
+            ]),
+        ]);
+    }
+    folderToChangeElement(kind, folder) {
+        return element(WbxmlCodePage.FolderHierarchy, kind, [
+            textElement(WbxmlCodePage.FolderHierarchy, "ServerId", folder.uid),
+            textElement(WbxmlCodePage.FolderHierarchy, "ParentId", folder.parentFolderUid ?? ROOT_PARENT_ID),
+            textElement(WbxmlCodePage.FolderHierarchy, "DisplayName", folder.name),
+            /* v8 ignore next -- unreachable via real data: FOLDER_TYPE_CODES has an entry for every FolderType
+               enum value, so the `??` fallback only guards a future enum member added to one without the
+               other; `folder.type` can never carry a value outside the enum. */
+            textElement(WbxmlCodePage.FolderHierarchy, "Type", FOLDER_TYPE_CODES[folder.type] ?? FOLDER_TYPE_CODES[FolderType.USER]),
+        ]);
+    }
+    async persistSyncKey(ctx, newKey) {
+        const folderSyncKeys = { ...ctx.deviceSyncState.folderSyncKeys, [FOLDER_HIERARCHY_CURSOR_KEY]: newKey };
+        await persistDeviceSyncState(ctx.deviceSyncState, ctx.deviceSyncStateRepo, { folderSyncKeys });
+    }
+}
+__decorate([
+    Config("mail:eas:foldersync_window_size", DEFAULT_WINDOW_SIZE),
+    __metadata("design:type", Number)
+], FolderSyncCommand.prototype, "windowSize", void 0);
+__decorate([
+    Init,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], FolderSyncCommand.prototype, "init", null);
+//# sourceMappingURL=FolderSyncCommand.js.map

package/dist/lib/commands/FolderSyncCommand.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FolderSyncCommand.js","sourceRoot":"","sources":["../../../src/commands/FolderSyncCommand.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+EAA+E;AAC/E,mEAAmE;AACnE,mCAAmC;AACnC,+EAA+E;AAC/E,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAiB,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAChG,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAqB,MAAM,0BAA0B,CAAC;AAC9F,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAE9G,OAAO,EAAU,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACtD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,gBAAgB,CAAC;AAE1C;;;;wDAIwD;AACxD,MAAM,iBAAiB,GAA+B;IAClD,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,GAAG;IACvB,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,GAAG;IACxB,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,GAAG;IAC/B,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,GAAG;IAC5B,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,GAAG;IACxB,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,GAAG;IACvB,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,GAAG;IAC1B,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,GAAG;IAC1B,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI;IACxB,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI;IACvB,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI;CAC1B,CAAC;AAEF,0GAA0G;AAC1G,MAAM,cAAc,GAAG,GAAG,CAAC;AAE3B;;kGAEkG;AAClG,MAAM,2BAA2B,GAAG,aAAa,CAAC;AAElD;;;kBAGkB;AAClB,MAAM,mBAAmB,GAAG,GAAG,CAAC;AAEhC;;;;;;;;;;GAUG;AACH,MAAM,OAAgB,iBAAiB;IAAvC;QACoB,YAAO,GAAG,YAAY,CAAC;QAK/B,eAAU,GAAW,mBAAmB,CAAC;IA6FrD,CAAC;IArFgB,AAAN,KAAK,CAAC,IAAI;QACb,IAAI,CAAC,UAAU,GAAG,MAAM,IAAI,CAAC,cAAe,CAAC,WAAW,CAAC,SAAS,EAAE;YAChE,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;YAC3B,IAAI,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC;SAC3B,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,GAAsB;QACtC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACnB,MAAM,IAAI,QAAQ,CAAC,SAAS,CAAC,cAAc,EAAE,GAAG,EAAE,gBAAgB,CAAC,cAAc,CAAC,CAAC;QACvF,CAAC;QAED,MAAM,aAAa,GAAuB,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACtG,MAAM,aAAa,GAAuB,GAAG,CAAC,eAAe,CAAC,cAAc,CAAC,2BAA2B,CAAC,CAAC;QAC1G,MAAM,UAAU,GAAG,cAAc,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;QAEhE,IAAI,UAAU,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,OAAO,CAAC,aAAa,CAAC,eAAe,EAAE,YAAY,EAAE;gBACxD,WAAW,CAAC,aAAa,CAAC,eAAe,EAAE,QAAQ,EAAE,GAAG,CAAC;aAC5D,CAAC,CAAC;QACP,CAAC;QAED,IAAI,UAAU,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAChC,6FAA6F;YAC7F,iGAAiG;YACjG,+FAA+F;YAC/F,8FAA8F;YAC9F,iGAAiG;YACjG,4FAA4F;YAC5F,MAAM,MAAM,GAAG,aAAa,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,SAAS,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACxE,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YACvC,OAAO,OAAO,CAAC,aAAa,CAAC,eAAe,EAAE,YAAY,EAAE;gBACxD,WAAW,CAAC,aAAa,CAAC,eAAe,EAAE,QAAQ,EAAE,GAAG,CAAC;gBACzD,WAAW,CAAC,aAAa,CAAC,eAAe,EAAE,SAAS,EAAE,MAAM,CAAC;aAChE,CAAC,CAAC;QACP,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,YAAY,EAAE,GAAG,CAAC,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/H,MAAM,MAAM,GAAG,aAAa,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC,UAAU,GAAG,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;QAC7G,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAEvC,MAAM,YAAY,GAAW,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;QACnG,IAAI,YAAY,KAAK,CAAC,EAAE,CAAC;YACrB,OAAO,OAAO,CAAC,aAAa,CAAC,eAAe,EAAE,YAAY,EAAE;gBACxD,WAAW,CAAC,aAAa,CAAC,eAAe,EAAE,QAAQ,EAAE,GAAG,CAAC;gBACzD,WAAW,CAAC,aAAa,CAAC,eAAe,EAAE,SAAS,EAAE,MAAM,CAAC;aAChE,CAAC,CAAC;QACP,CAAC;QAED,MAAM,cAAc,GAAmB;YACnC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAC1E,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAChF,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAC9B,OAAO,CAAC,aAAa,CAAC,eAAe,EAAE,QAAQ,EAAE;gBAC7C,WAAW,CAAC,aAAa,CAAC,eAAe,EAAE,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC;aACrE,CAAC,CACL;SACJ,CAAC;QAEF,OAAO,OAAO,CAAC,aAAa,CAAC,eAAe,EAAE,YAAY,EAAE;YACxD,WAAW,CAAC,aAAa,CAAC,eAAe,EAAE,QAAQ,EAAE,GAAG,CAAC;YACzD,WAAW,CAAC,aAAa,CAAC,eAAe,EAAE,SAAS,EAAE,MAAM,CAAC;YAC7D,OAAO,CAAC,aAAa,CAAC,eAAe,EAAE,SAAS,EAAE;gBAC9C,WAAW,CAAC,aAAa,CAAC,eAAe,EAAE,OAAO,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;gBACzE,GAAG,cAAc;aACpB,CAAC;SACL,CAAC,CAAC;IACP,CAAC;IAEO,qBAAqB,CAAC,IAAsB,EAAE,MAAS;QAC3D,OAAO,OAAO,CAAC,aAAa,CAAC,eAAe,EAAE,IAAI,EAAE;YAChD,WAAW,CAAC,aAAa,CAAC,eAAe,EAAE,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC;YAClE,WAAW,CAAC,aAAa,CAAC,eAAe,EAAE,UAAU,EAAE,MAAM,CAAC,eAAe,IAAI,cAAc,CAAC;YAChG,WAAW,CAAC,aAAa,CAAC,eAAe,EAAE,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC;YACtE;;gFAEoE;YACpE,WAAW,CAAC,aAAa,CAAC,eAAe,EAAE,MAAM,EAAE,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,iBAAiB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;SAC3H,CAAC,CAAC;IACP,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,GAAsB,EAAE,MAAc;QAC/D,MAAM,cAAc,GAAG,EAAE,GAAG,GAAG,CAAC,eAAe,CAAC,cAAc,EAAE,CAAC,2BAA2B,CAAC,EAAE,MAAM,EAAE,CAAC;QACxG,MAAM,sBAAsB,CAAC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC,mBAAmB,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC;IACnG,CAAC;CACJ;AA7FW;IADP,MAAM,CAAC,iCAAiC,EAAE,mBAAmB,CAAC;;qDACd;AAQpC;IADZ,IAAI;;;;6CAMJ"}

package/dist/lib/commands/GetItemEstimateCommand.js

@@ -0,0 +1,149 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz. All rights reserved.
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+import { ApiError, ObjectDecorators } from "@rapidrest/core";
+import { ACLAction, ACLUtils, ApiErrorMessages, ApiErrors } from "@rapidrest/service-core";
+import { RecoverableRepoUtils } from "@rapidmx/restapi";
+import { WbxmlCodePage } from "../codec/WbxmlCodePages.js";
+import { childText, element, findChild, findChildren, textElement } from "../codec/WbxmlElement.js";
+import { computeChanges, resolveSyncKey } from "../EasSyncKeyUtils.js";
+const { Config, Init, Inject } = ObjectDecorators;
+/** Caps how many changes `computeChanges()` will actually enumerate (and therefore count) per collection for
+ * an already-synced folder - a real estimate, not a precise unbounded count, matching the command's own name;
+ * a folder with more pending changes than this reports exactly this many, not the true total. Deliberately
+ * separate from `SyncCommand`'s own `mail:eas:sync_window_size` - the two commands have no reason to share one
+ * config knob just because they happen to reuse the same underlying enumeration helper. */
+const DEFAULT_MAX_COUNT = 512;
+/**
+ * Handles EAS `GetItemEstimate`: reports, per requested `<Collection>`, an estimated count of the
+ * `Add`/`Change`/`Delete`s a subsequent `Sync` of that collection would return - read-only, it never issues or
+ * consumes a `SyncKey` itself.
+ *
+ * The modern (14.0+) request/response reuses `WbxmlCodePage.AirSync`'s own `Collections`/`Collection`/`Class`/
+ * `CollectionId`/`SyncKey` via `SWITCH_PAGE` rather than this page's own legacy (`Folders`/`Folder`/`FolderId`)
+ * shape - see `WbxmlCodePages.ts`'s own doc comment on `WbxmlCodePage.ItemEstimate` for why, and
+ * `ItemOperationsCommand.fetchMessage`'s identical cross-page-reuse precedent.
+ *
+ * A `SyncKey` of `"0"` (or one this device has never synced this folder with before) reports the folder's
+ * total live item count - what a first `Sync` would report as `Add`s. Otherwise reuses `EasSyncKeyUtils.
+ * computeChanges()` (the same enumeration `SyncCommand` itself uses), capped at `DEFAULT_MAX_COUNT` - see its
+ * own doc comment for why this is a real, documented approximation on a very active folder rather than a
+ * precise unbounded count.
+ *
+ * **ACL-checked like `Sync`**: `estimateCollection()` requires `ACLAction.READ` on the client-supplied
+ * `CollectionId` before counting anything - without it, a crafted `CollectionId` belonging to another
+ * mailbox's folder would return a real pending-change count for it. A denied folder is reported identically to
+ * an unrecognized collection (`Status 2`), never distinguishable from "you don't have this collection at all".
+ *
+ * @author Jean-Philippe Steinmetz
+ */
+export class GetItemEstimateCommand {
+    constructor() {
+        this.command = "GetItemEstimate";
+        this.maxCount = DEFAULT_MAX_COUNT;
+        this.repos = new Map();
+    }
+    async init() {
+        for (const [collectionClass, binding] of Object.entries(this.collectionBindings)) {
+            this.repos.set(collectionClass, await this._objectFactory.newInstance(RecoverableRepoUtils, {
+                name: binding.entityClass.name,
+                args: [binding.entityClass],
+            }));
+        }
+    }
+    async handle(ctx) {
+        if (!this.aclUtils) {
+            throw new ApiError(ApiErrors.INTERNAL_ERROR, 500, ApiErrorMessages.INTERNAL_ERROR);
+        }
+        const collections = ctx.request ? findChild(ctx.request, "Collections") : undefined;
+        const collectionEls = collections ? findChildren(collections, "Collection") : [];
+        if (collectionEls.length === 0) {
+            return element(WbxmlCodePage.ItemEstimate, "GetItemEstimate", [
+                element(WbxmlCodePage.ItemEstimate, "Response", [
+                    textElement(WbxmlCodePage.ItemEstimate, "Status", "2"),
+                ]),
+            ]);
+        }
+        const responses = [];
+        for (const collectionEl of collectionEls) {
+            responses.push(await this.estimateCollection(ctx, collectionEl));
+        }
+        return element(WbxmlCodePage.ItemEstimate, "GetItemEstimate", responses);
+    }
+    async estimateCollection(ctx, collectionEl) {
+        const collectionClass = childText(collectionEl, "Class");
+        const folderUid = childText(collectionEl, "CollectionId");
+        const clientSyncKey = childText(collectionEl, "SyncKey");
+        const repo = collectionClass ? this.repos.get(collectionClass) : undefined;
+        if (!collectionClass || !folderUid || !repo) {
+            // Status 2 ("Invalid collection") per [MS-ASCMD] - the request named a collection this device
+            // hasn't (or can't) sync.
+            return element(WbxmlCodePage.ItemEstimate, "Response", [
+                textElement(WbxmlCodePage.ItemEstimate, "Status", "2"),
+            ]);
+        }
+        // Never count against a folder the caller can't even read - see this class's own doc comment.
+        if (!(await this.aclUtils.hasPermission(ctx.user, folderUid, ACLAction.READ))) {
+            return element(WbxmlCodePage.ItemEstimate, "Response", [
+                textElement(WbxmlCodePage.ItemEstimate, "Status", "2"),
+            ]);
+        }
+        const storedSyncKey = ctx.deviceSyncState.folderSyncKeys[folderUid];
+        const resolution = resolveSyncKey(clientSyncKey, storedSyncKey);
+        if (resolution.kind === "invalid") {
+            return element(WbxmlCodePage.ItemEstimate, "Response", [
+                textElement(WbxmlCodePage.ItemEstimate, "Status", "2"),
+                this.collectionElement(collectionClass, folderUid, undefined),
+            ]);
+        }
+        // A brand-new (or never-synced-by-this-device) folder: every live item would be reported as an Add on
+        // the device's first real Sync round - a plain count() of non-deleted rows (excluded by default; see
+        // computeChanges()'s own doc comment on this query builder behavior), not computeChanges() itself,
+        // which would incorrectly also count this folder's entire soft-deleted history (irrelevant to a client
+        // that has never seen any of those rows in the first place).
+        let count;
+        if (resolution.kind === "initial") {
+            count = await repo.count({ folderUid }, { ignoreACL: true });
+        }
+        else {
+            const changes = await computeChanges(repo, "folderUid", folderUid, resolution.key.watermark, this.maxCount);
+            count = changes.adds.length + changes.changes.length + changes.deletes.length;
+        }
+        return element(WbxmlCodePage.ItemEstimate, "Response", [
+            textElement(WbxmlCodePage.ItemEstimate, "Status", "1"),
+            this.collectionElement(collectionClass, folderUid, count),
+        ]);
+    }
+    collectionElement(collectionClass, folderUid, estimate) {
+        return element(WbxmlCodePage.AirSync, "Collection", [
+            textElement(WbxmlCodePage.AirSync, "Class", collectionClass),
+            textElement(WbxmlCodePage.AirSync, "CollectionId", folderUid),
+            ...(estimate !== undefined ? [textElement(WbxmlCodePage.ItemEstimate, "Estimate", String(estimate))] : []),
+        ]);
+    }
+}
+__decorate([
+    Config("mail:eas:item_estimate_max_count", DEFAULT_MAX_COUNT),
+    __metadata("design:type", Number)
+], GetItemEstimateCommand.prototype, "maxCount", void 0);
+__decorate([
+    Inject(ACLUtils),
+    __metadata("design:type", ACLUtils)
+], GetItemEstimateCommand.prototype, "aclUtils", void 0);
+__decorate([
+    Init,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], GetItemEstimateCommand.prototype, "init", null);
+//# sourceMappingURL=GetItemEstimateCommand.js.map

package/dist/lib/commands/GetItemEstimateCommand.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GetItemEstimateCommand.js","sourceRoot":"","sources":["../../../src/commands/GetItemEstimateCommand.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+EAA+E;AAC/E,mEAAmE;AACnE,mCAAmC;AACnC,+EAA+E;AAC/E,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,gBAAgB,EAAE,SAAS,EAA4B,MAAM,yBAAyB,CAAC;AACrH,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,WAAW,EAAqB,MAAM,0BAA0B,CAAC;AACvH,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAC;AAElD;;;;2FAI2F;AAC3F,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAS9B;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,OAAgB,sBAAsB;IAA5C;QACoB,YAAO,GAAG,iBAAiB,CAAC;QAKpC,aAAQ,GAAW,iBAAiB,CAAC;QAQrC,UAAK,GAAG,IAAI,GAAG,EAA0B,CAAC;IA6FtD,CAAC;IA1FgB,AAAN,KAAK,CAAC,IAAI;QACb,KAAK,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAC/E,IAAI,CAAC,KAAK,CAAC,GAAG,CACV,eAAe,EACf,MAAM,IAAI,CAAC,cAAe,CAAC,WAAW,CAAC,oBAAoB,EAAE;gBACzD,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,IAAI;gBAC9B,IAAI,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC;aAC9B,CAAC,CACL,CAAC;QACN,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,GAAsB;QACtC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjB,MAAM,IAAI,QAAQ,CAAC,SAAS,CAAC,cAAc,EAAE,GAAG,EAAE,gBAAgB,CAAC,cAAc,CAAC,CAAC;QACvF,CAAC;QACD,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACpF,MAAM,aAAa,GAAG,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACjF,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,OAAO,OAAO,CAAC,aAAa,CAAC,YAAY,EAAE,iBAAiB,EAAE;gBAC1D,OAAO,CAAC,aAAa,CAAC,YAAY,EAAE,UAAU,EAAE;oBAC5C,WAAW,CAAC,aAAa,CAAC,YAAY,EAAE,QAAQ,EAAE,GAAG,CAAC;iBACzD,CAAC;aACL,CAAC,CAAC;QACP,CAAC;QAED,MAAM,SAAS,GAAmB,EAAE,CAAC;QACrC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACvC,SAAS,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAC;QACrE,CAAC;QAED,OAAO,OAAO,CAAC,aAAa,CAAC,YAAY,EAAE,iBAAiB,EAAE,SAAS,CAAC,CAAC;IAC7E,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,GAAsB,EAAE,YAA0B;QAC/E,MAAM,eAAe,GAAuB,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAC7E,MAAM,SAAS,GAAuB,SAAS,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;QAC9E,MAAM,aAAa,GAAuB,SAAS,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAE7E,MAAM,IAAI,GAAG,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3E,IAAI,CAAC,eAAe,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,EAAE,CAAC;YAC1C,8FAA8F;YAC9F,0BAA0B;YAC1B,OAAO,OAAO,CAAC,aAAa,CAAC,YAAY,EAAE,UAAU,EAAE;gBACnD,WAAW,CAAC,aAAa,CAAC,YAAY,EAAE,QAAQ,EAAE,GAAG,CAAC;aACzD,CAAC,CAAC;QACP,CAAC;QAED,8FAA8F;QAC9F,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,QAAS,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YAC7E,OAAO,OAAO,CAAC,aAAa,CAAC,YAAY,EAAE,UAAU,EAAE;gBACnD,WAAW,CAAC,aAAa,CAAC,YAAY,EAAE,QAAQ,EAAE,GAAG,CAAC;aACzD,CAAC,CAAC;QACP,CAAC;QAED,MAAM,aAAa,GAAG,GAAG,CAAC,eAAe,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;QACpE,MAAM,UAAU,GAAG,cAAc,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;QAChE,IAAI,UAAU,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,OAAO,CAAC,aAAa,CAAC,YAAY,EAAE,UAAU,EAAE;gBACnD,WAAW,CAAC,aAAa,CAAC,YAAY,EAAE,QAAQ,EAAE,GAAG,CAAC;gBACtD,IAAI,CAAC,iBAAiB,CAAC,eAAe,EAAE,SAAS,EAAE,SAAS,CAAC;aAChE,CAAC,CAAC;QACP,CAAC;QAED,sGAAsG;QACtG,qGAAqG;QACrG,mGAAmG;QACnG,uGAAuG;QACvG,6DAA6D;QAC7D,IAAI,KAAa,CAAC;QAClB,IAAI,UAAU,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAChC,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,EAAE,SAAS,EAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACxE,CAAC;aAAM,CAAC;YACJ,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC5G,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;QAClF,CAAC;QAED,OAAO,OAAO,CAAC,aAAa,CAAC,YAAY,EAAE,UAAU,EAAE;YACnD,WAAW,CAAC,aAAa,CAAC,YAAY,EAAE,QAAQ,EAAE,GAAG,CAAC;YACtD,IAAI,CAAC,iBAAiB,CAAC,eAAe,EAAE,SAAS,EAAE,KAAK,CAAC;SAC5D,CAAC,CAAC;IACP,CAAC;IAEO,iBAAiB,CAAC,eAAuB,EAAE,SAAiB,EAAE,QAA4B;QAC9F,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,EAAE,YAAY,EAAE;YAChD,WAAW,CAAC,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,CAAC;YAC5D,WAAW,CAAC,aAAa,CAAC,OAAO,EAAE,cAAc,EAAE,SAAS,CAAC;YAC7D,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,YAAY,EAAE,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SAC7G,CAAC,CAAC;IACP,CAAC;CACJ;AArGW;IADP,MAAM,CAAC,kCAAkC,EAAE,iBAAiB,CAAC;;wDACjB;AAMrC;IADP,MAAM,CAAC,QAAQ,CAAC;8BACE,QAAQ;wDAAC;AAKf;IADZ,IAAI;;;;kDAWJ"}