@rapidmx/activesync-plugin 1.0.0-beta.2

package/dist/types/models/mongo/DeviceSyncStateMongo.d.ts

@@ -0,0 +1,22 @@
+import { BaseMongoEntity } from "@rapidrest/service-core";
+import { DeviceSyncState } from "../DeviceSyncState.js";
+/**
+ * Implementation of the `DeviceSyncState` interface for storage in a MongoDB database. If SQL is desired,
+ * please use `models.sql.DeviceSyncStateSQL` instead.
+ *
+ * @author Jean-Philippe Steinmetz
+ */
+export declare class DeviceSyncStateMongo extends BaseMongoEntity implements DeviceSyncState {
+    mailboxUid: string;
+    deviceId: string;
+    deviceType: string;
+    policyKey?: string;
+    folderSyncKeys: Record<string, string>;
+    folderCollectionClasses: Record<string, string>;
+    lastSyncAt?: Date;
+    provisioned: boolean;
+    remoteWipeRequested?: boolean;
+    remoteWipeAccountOnly?: boolean;
+    remoteWipeAcknowledgedAt?: Date;
+    constructor(other?: Partial<DeviceSyncStateMongo>);
+}

package/dist/types/models/sql/DeviceSyncStateSQL.d.ts

@@ -0,0 +1,22 @@
+import { BaseEntity } from "@rapidrest/service-core";
+import { DeviceSyncState } from "../DeviceSyncState.js";
+/**
+ * Implementation of the `DeviceSyncState` interface for storage in a SQL database. If MongoDB is desired,
+ * please use `models.mongo.DeviceSyncStateMongo` instead.
+ *
+ * @author Jean-Philippe Steinmetz
+ */
+export declare class DeviceSyncStateSQL extends BaseEntity implements DeviceSyncState {
+    mailboxUid: string;
+    deviceId: string;
+    deviceType: string;
+    policyKey?: string;
+    folderSyncKeys: Record<string, string>;
+    folderCollectionClasses: Record<string, string>;
+    lastSyncAt?: Date;
+    provisioned: boolean;
+    remoteWipeRequested?: boolean;
+    remoteWipeAccountOnly?: boolean;
+    remoteWipeAcknowledgedAt?: Date;
+    constructor(other?: Partial<DeviceSyncStateSQL>);
+}

package/dist/types/mongo/DeviceSyncStateRouteMongo.d.ts

@@ -0,0 +1,8 @@
+import { DeviceSyncStateMongo } from "../models/mongo/DeviceSyncStateMongo.js";
+import { BaseDeviceSyncStateRoute } from "../BaseDeviceSyncStateRoute.js";
+/**
+ * @author Jean-Philippe Steinmetz
+ */
+export declare class DeviceSyncStateRouteMongo extends BaseDeviceSyncStateRoute<DeviceSyncStateMongo> {
+    protected deviceSyncStateClass: any;
+}

package/dist/types/mongo/EasRouteMongo.d.ts

@@ -0,0 +1,14 @@
+import { MailboxMongo } from "@rapidmx/restapi/mongo";
+import { DeviceSyncStateMongo } from "../models/mongo/DeviceSyncStateMongo.js";
+import { BaseEasRoute } from "../BaseEasRoute.js";
+/**
+ * Mongo-backed concrete `BaseEasRoute`, mounted at the protocol's well-known path. Exported from this plugin's
+ * `./mongo` entry point, so the server host mounts it without a wrapper class of its own.
+ *
+ * @author Jean-Philippe Steinmetz
+ */
+export declare class EasRouteMongo extends BaseEasRoute<DeviceSyncStateMongo, MailboxMongo> {
+    protected deviceSyncStateClass: any;
+    protected mailboxClass: any;
+    protected commandHandlerClasses: any[];
+}

package/dist/types/mongo/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./EasRouteMongo.js";
+export * from "./DeviceSyncStateRouteMongo.js";
+export * from "../commands/mongo/index.js";
+export * from "../adapters/mongo/index.js";

package/dist/types/mongo.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This plugin's `./mongo` entry point: exactly the classes a server host loads for a Mongo deployment - the
+ * mounted routes, the device-state model and its cleanup job. Anything else exported here would be registered
+ * by the host too (and an abstract `BackgroundService` would even be started), so the command and adapter
+ * classes these routes use stay internal.
+ */
+export { EasRouteMongo } from "./mongo/EasRouteMongo.js";
+export { DeviceSyncStateRouteMongo } from "./mongo/DeviceSyncStateRouteMongo.js";
+export { DeviceSyncStateMongo } from "./models/mongo/DeviceSyncStateMongo.js";
+export { EasDeviceStateCleanupJobMongo } from "./jobs/mongo/EasDeviceStateCleanupJobMongo.js";

package/dist/types/sql/DeviceSyncStateRouteSQL.d.ts

@@ -0,0 +1,8 @@
+import { DeviceSyncStateSQL } from "../models/sql/DeviceSyncStateSQL.js";
+import { BaseDeviceSyncStateRoute } from "../BaseDeviceSyncStateRoute.js";
+/**
+ * @author Jean-Philippe Steinmetz
+ */
+export declare class DeviceSyncStateRouteSQL extends BaseDeviceSyncStateRoute<DeviceSyncStateSQL> {
+    protected deviceSyncStateClass: any;
+}

package/dist/types/sql/EasRouteSQL.d.ts

@@ -0,0 +1,14 @@
+import { MailboxSQL } from "@rapidmx/restapi/sql";
+import { DeviceSyncStateSQL } from "../models/sql/DeviceSyncStateSQL.js";
+import { BaseEasRoute } from "../BaseEasRoute.js";
+/**
+ * SQL-backed concrete `BaseEasRoute`, mounted at the protocol's well-known path. Exported from this plugin's
+ * `./sql` entry point.
+ *
+ * @author Jean-Philippe Steinmetz
+ */
+export declare class EasRouteSQL extends BaseEasRoute<DeviceSyncStateSQL, MailboxSQL> {
+    protected deviceSyncStateClass: any;
+    protected mailboxClass: any;
+    protected commandHandlerClasses: any[];
+}

package/dist/types/sql/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./EasRouteSQL.js";
+export * from "./DeviceSyncStateRouteSQL.js";
+export * from "../commands/sql/index.js";
+export * from "../adapters/sql/index.js";

package/dist/types/sql.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This plugin's `./sql` entry point: exactly the classes a server host loads for a SQL deployment - the
+ * mounted routes, the device-state model and its cleanup job. Anything else exported here would be registered
+ * by the host too (and an abstract `BackgroundService` would even be started), so the command and adapter
+ * classes these routes use stay internal.
+ */
+export { EasRouteSQL } from "./sql/EasRouteSQL.js";
+export { DeviceSyncStateRouteSQL } from "./sql/DeviceSyncStateRouteSQL.js";
+export { DeviceSyncStateSQL } from "./models/sql/DeviceSyncStateSQL.js";
+export { EasDeviceStateCleanupJobSQL } from "./jobs/sql/EasDeviceStateCleanupJobSQL.js";

package/package.json

@@ -0,0 +1,238 @@
+{
+    "name": "@rapidmx/activesync-plugin",
+    "version": "1.0.0-beta.2",
+    "description": "RapixMX plugin that provides Exchange ActiveSync (EAS) protocol support.",
+    "repository": "https://github.com/RapidMX/activesync.git",
+    "author": "RapidREST <rapidrests@gmail.com>",
+    "license": "MPL-2.0",
+    "contributors": [
+        "Jean-Philippe Steinmetz"
+    ],
+    "scripts": {
+        "build": "yarn lint && rimraf dist && tsc",
+        "lint": "eslint ./src ./test",
+        "local-audit": "yarn install && yarn npm audit -A -R \"$@\"",
+        "checkup": "yarn dlx @yarnpkg/doctor \"$@\"",
+        "dependency-check": "yarn dlx depcheck \"$@\"",
+        "report-coverage": "cat ./coverage/lcov.info | coveralls",
+        "test": "vitest run",
+        "test:prod": "npm run lint && vitest run --coverage",
+        "test:watch": "vitest",
+        "release": "npx @rapidrest/cli release",
+        "prepublish": "yarn build"
+    },
+    "peerDependencies": {
+        "@rapidmx/restapi": "0.x",
+        "@rapidrest/core": "5.x",
+        "@rapidrest/service-core": "2.x"
+    },
+    "dependencies": {
+        "mailparser": "^3.9.23"
+    },
+    "devDependencies": {
+        "@rapidmx/restapi": "^0.9.0",
+        "@rapidrest/core": "^5.2.2",
+        "@rapidrest/service-core": "^2.0.0",
+        "@swc/core": "^1.16.2",
+        "@types/mailparser": "^3.4.6",
+        "@types/nconf": "^0.10.7",
+        "@types/node": "^26.5.0",
+        "@typescript-eslint/eslint-plugin": "^8.70.0",
+        "@typescript-eslint/parser": "^8.70.0",
+        "@vitest/coverage-v8": "^5.0.0",
+        "better-sqlite3": "^13.0.3",
+        "eslint": "^10.10.0",
+        "eslint-config-prettier": "^10.1.8",
+        "eslint-plugin-import": "^2.32.0",
+        "eslint-plugin-jsdoc": "^64.3.6",
+        "globals": "^17.12.0",
+        "lodash-es": "^4.18.1",
+        "mongodb": "^7.6.0",
+        "mongodb-memory-server": "^11.2.0",
+        "nconf": "^0.13.0",
+        "openapi3-ts": "^4.6.1",
+        "prom-client": "^15.1.3",
+        "redis": "^6.2.1",
+        "reflect-metadata": "^0.2.2",
+        "rimraf": "^6.1.3",
+        "ts-node": "^10.9.2",
+        "tsx": "^4.23.13",
+        "typeorm": "^1.1.1",
+        "typescript": "^6.0.3",
+        "unplugin-swc": "^1.6.0",
+        "vite": "^8.2.2",
+        "vitest": "^5.0.0",
+        "winston": "^3.19.0"
+    },
+    "packageManager": "yarn@4.5.3",
+    "engines": {
+        "node": ">=24.0.0"
+    },
+    "publishConfig": {
+        "registry": "https://registry.npmjs.org/"
+    },
+    "type": "module",
+    "main": "dist/lib/index.js",
+    "exports": {
+        ".": {
+            "import": "./dist/lib/index.js",
+            "types": "./dist/types/index.d.ts"
+        },
+        "./mongo": {
+            "import": "./dist/lib/mongo.js",
+            "types": "./dist/types/mongo.d.ts"
+        },
+        "./sql": {
+            "import": "./dist/lib/sql.js",
+            "types": "./dist/types/sql.d.ts"
+        }
+    },
+    "typings": "dist/types/index.d.ts",
+    "files": [
+        "dist"
+    ],
+    "rapidmx": {
+        "plugin": {
+            "apiVersion": 1,
+            "displayName": "Exchange ActiveSync",
+            "description": "Lets phones and mail apps sync mail, contacts, calendars and tasks over Exchange ActiveSync (served at /Microsoft-Server-ActiveSync).",
+            "settings": [
+                {
+                    "key": "mail:eas:sync_window_size",
+                    "label": "Sync batch size",
+                    "type": "number",
+                    "default": 100,
+                    "min": 1,
+                    "max": 512,
+                    "help": "Most items sent to a device in one Sync response."
+                },
+                {
+                    "key": "mail:eas:foldersync_window_size",
+                    "label": "Folder sync batch size",
+                    "type": "number",
+                    "default": 512,
+                    "min": 1,
+                    "max": 5000,
+                    "help": "Most folder changes sent in one FolderSync response."
+                },
+                {
+                    "key": "mail:eas:item_estimate_max_count",
+                    "label": "Item estimate limit",
+                    "type": "number",
+                    "default": 512,
+                    "min": 1,
+                    "max": 100000,
+                    "help": "Highest count GetItemEstimate reports for a folder."
+                },
+                {
+                    "key": "mail:eas:itemoperations_max_fetch",
+                    "label": "Fetches per request",
+                    "type": "number",
+                    "default": 25,
+                    "min": 1,
+                    "max": 500,
+                    "help": "Most items a device may fetch in one ItemOperations request."
+                },
+                {
+                    "key": "mail:eas:itemoperations_batch_size",
+                    "label": "Fetch batch size",
+                    "type": "number",
+                    "default": 500,
+                    "min": 1,
+                    "max": 5000,
+                    "help": "Rows read per database query while fetching."
+                },
+                {
+                    "key": "mail:eas:ping_min_heartbeat_seconds",
+                    "label": "Minimum push heartbeat (seconds)",
+                    "type": "number",
+                    "default": 60,
+                    "min": 1,
+                    "max": 3600,
+                    "help": "Shortest Ping interval a device may request."
+                },
+                {
+                    "key": "mail:eas:ping_max_heartbeat_seconds",
+                    "label": "Maximum push heartbeat (seconds)",
+                    "type": "number",
+                    "default": 1740,
+                    "min": 60,
+                    "max": 3600,
+                    "help": "Longest Ping interval a device may request."
+                },
+                {
+                    "key": "mail:eas:search_default_range",
+                    "label": "Default search results",
+                    "type": "number",
+                    "default": 9,
+                    "min": 0,
+                    "max": 999,
+                    "help": "Last result index returned when a search doesn't ask for a range."
+                },
+                {
+                    "key": "mail:eas:search_max_range",
+                    "label": "Maximum search results",
+                    "type": "number",
+                    "default": 99,
+                    "min": 0,
+                    "max": 999,
+                    "help": "Highest result index a search may request."
+                },
+                {
+                    "key": "mail:eas:resolve_recipients_max_matches",
+                    "label": "Recipient lookup matches",
+                    "type": "number",
+                    "default": 10,
+                    "min": 1,
+                    "max": 100,
+                    "help": "Most matches returned per name when resolving recipients."
+                },
+                {
+                    "key": "mail:eas:provision:password_enabled",
+                    "label": "Require a device passcode",
+                    "type": "boolean",
+                    "default": true,
+                    "help": "Devices must set a passcode before syncing."
+                },
+                {
+                    "key": "mail:eas:provision:min_password_length",
+                    "label": "Minimum passcode length",
+                    "type": "number",
+                    "default": 4,
+                    "min": 1,
+                    "max": 16
+                },
+                {
+                    "key": "mail:eas:provision:max_failed_attempts",
+                    "label": "Failed unlocks before wipe",
+                    "type": "number",
+                    "default": 8,
+                    "min": 1,
+                    "max": 16
+                },
+                {
+                    "key": "mail:eas:provision:require_device_encryption",
+                    "label": "Require device encryption",
+                    "type": "boolean",
+                    "default": true
+                },
+                {
+                    "key": "mail:eas:provision:allow_simple_password",
+                    "label": "Allow simple passcodes",
+                    "type": "boolean",
+                    "default": false,
+                    "help": "For example 1111 or 1234."
+                },
+                {
+                    "key": "mail:jobs:eas_device_cleanup:device_ttl_days",
+                    "label": "Forget idle devices after (days)",
+                    "type": "number",
+                    "default": 90,
+                    "min": 1,
+                    "max": 3650,
+                    "help": "Device pairings that haven't synced for this long are removed."
+                }
+            ]
+        }
+    }
+}