@appium/coresim 1.13.0 → 1.13.1

package/lib/src/utils/bulletin-board-model-v3.js

@@ -0,0 +1,16 @@
+import { buildSectionInfo } from './bulletin-board-model-v2.js';
+/** The format used by SpringBoard since iOS 27: v2 with `isLocked` in the `BBSectionInfo`. */
+export const bulletinBoardModelV3 = {
+    version: 3,
+    createStore: () => ({ sectionInfoVersionNumber: 3 }),
+    setNotificationsStatus(store, bundleId, status) {
+        const sectionInfo = (store.sectionInfo ??= {});
+        if (status === 'unset') {
+            delete sectionInfo[bundleId];
+        }
+        else {
+            sectionInfo[bundleId] = buildSectionInfo(bundleId, status, { isLocked: false });
+        }
+    },
+};
+//# sourceMappingURL=bulletin-board-model-v3.js.map

package/lib/src/utils/bulletin-board-model-v3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulletin-board-model-v3.js","sourceRoot":"","sources":["../../../src/utils/bulletin-board-model-v3.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,gBAAgB,EAAC,MAAM,8BAA8B,CAAC;AAG9D,8FAA8F;AAC9F,MAAM,CAAC,MAAM,oBAAoB,GAAuB;IACtD,OAAO,EAAE,CAAC;IACV,WAAW,EAAE,GAAG,EAAE,CAAC,CAAC,EAAC,wBAAwB,EAAE,CAAC,EAAC,CAAC;IAClD,sBAAsB,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM;QAC5C,MAAM,WAAW,GAAG,CAAC,KAAK,CAAC,WAAW,KAAK,EAAE,CAAC,CAAC;QAC/C,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;YACvB,OAAO,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC/B,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,QAAQ,CAAC,GAAG,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAC,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAC;QAChF,CAAC;IACH,CAAC;CACF,CAAC"}

package/lib/src/utils/bulletin-board-model.d.ts

@@ -0,0 +1,19 @@
+export type NotificationsStatus = 'granted' | 'denied' | 'critical' | 'unset';
+/** Content of `VersionedSectionInfo.plist`. */
+export interface BulletinBoardStoreContent {
+    sectionInfoVersionNumber?: number;
+    sectionInfo?: Record<string, Uint8Array>;
+}
+/**
+ * The data model of one `sectionInfoVersionNumber` of the BulletinBoard store. The store operations
+ * (locking, atomic replace, ...) don't depend on it, so a new format version only needs a new model.
+ */
+export interface BulletinBoardModel {
+    /** The `sectionInfoVersionNumber` this model reads and writes. */
+    readonly version: number;
+    /** An empty store, as SpringBoard of this version would start it. */
+    createStore(): BulletinBoardStoreContent;
+    /** Adds, replaces or (`unset`) removes the app's notifications section in place. */
+    setNotificationsStatus(store: BulletinBoardStoreContent, bundleId: string, status: NotificationsStatus): void;
+}
+//# sourceMappingURL=bulletin-board-model.d.ts.map

package/lib/src/utils/bulletin-board-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulletin-board-model.d.ts","sourceRoot":"","sources":["../../../src/utils/bulletin-board-model.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,OAAO,CAAC;AAE9E,+CAA+C;AAC/C,MAAM,WAAW,yBAAyB;IACxC,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,kEAAkE;IAClE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,qEAAqE;IACrE,WAAW,IAAI,yBAAyB,CAAC;IACzC,oFAAoF;IACpF,sBAAsB,CAAC,KAAK,EAAE,yBAAyB,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,GAAG,IAAI,CAAC;CAC/G"}

package/lib/src/utils/bulletin-board-model.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=bulletin-board-model.js.map

package/lib/src/utils/bulletin-board-model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulletin-board-model.js","sourceRoot":"","sources":["../../../src/utils/bulletin-board-model.ts"],"names":[],"mappings":""}

package/lib/src/utils/bulletin-board-store.d.ts

@@ -0,0 +1,41 @@
+import type { NotificationsStatus } from './bulletin-board-model.js';
+/**
+ * SpringBoard's BulletinBoard store of a device (`Library/BulletinBoard/VersionedSectionInfo.plist`),
+ * which keeps the notifications settings of every app as one archived `BBSectionInfo` per bundle id.
+ */
+export declare class BulletinBoardStore {
+    readonly path: string;
+    private readonly models;
+    /**
+     * @param dataPath — data directory of the device
+     * @param versions — the `sectionInfoVersionNumber`s supported by the runtime, the oldest first
+     * (all the known ones by default). A store of any other version is refused, as the format may
+     * change in a future runtime. A missing store (a never-booted device) is created in the first
+     * one, as SpringBoard migrates older versions but not newer ones.
+     * @throws {Error} if a version is unknown
+     */
+    constructor(dataPath: string, versions?: readonly number[]);
+    /**
+     * Runs `update` once every earlier update of the same store has settled: concurrent updates for
+     * different apps would otherwise read the same store, and the last write would drop the other app's
+     * section. Only the calls made by this process are serialized.
+     */
+    withLock<T>(update: () => Promise<T>): Promise<T>;
+    /**
+     * Adds, replaces or (`unset`) removes the app's section. The store is replaced atomically, so a
+     * failed write leaves the previous one intact. A device that has never been booted has no store
+     * yet: it is created with just this section, and SpringBoard adds the rest on boot.
+     *
+     * @returns `false` if there was nothing to write (`unset` without a store)
+     * @throws {Error} if the existing store is of an unsupported format version
+     */
+    setNotificationsStatus(bundleId: string, status: NotificationsStatus): Promise<boolean>;
+    /**
+     * Makes the store immutable (`uchg`) so that nothing, including a dying SpringBoard, can rewrite it.
+     * Best effort.
+     */
+    setImmutable(immutable: boolean): Promise<void>;
+    private modelOf;
+    private replace;
+}
+//# sourceMappingURL=bulletin-board-store.d.ts.map

package/lib/src/utils/bulletin-board-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulletin-board-store.d.ts","sourceRoot":"","sources":["../../../src/utils/bulletin-board-store.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAgD,mBAAmB,EAAC,MAAM,2BAA2B,CAAC;AAUlH;;;GAGG;AACH,qBAAa,kBAAkB;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgC;IAEvD;;;;;;;OAOG;gBACS,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAE,SAAS,MAAM,EAA6C;IAWpG;;;;OAIG;IACG,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAgBvD;;;;;;;OAOG;IACG,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAkB7F;;;OAGG;IACG,YAAY,CAAC,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAMrD,OAAO,CAAC,OAAO;YAWD,OAAO;CAWtB"}

package/lib/src/utils/bulletin-board-store.js

@@ -0,0 +1,114 @@
+import { execFile } from 'node:child_process';
+import { randomUUID } from 'node:crypto';
+import path from 'node:path';
+import { promisify } from 'node:util';
+import { fs, plist } from '@appium/support';
+import { bulletinBoardModelV2 } from './bulletin-board-model-v2.js';
+import { bulletinBoardModelV3 } from './bulletin-board-model-v3.js';
+const execFileAsync = promisify(execFile);
+// All the known data models, the oldest first.
+const KNOWN_MODELS = [bulletinBoardModelV2, bulletinBoardModelV3];
+// The last pending update of each store, see BulletinBoardStore.withLock.
+const pendingUpdates = new Map();
+/**
+ * SpringBoard's BulletinBoard store of a device (`Library/BulletinBoard/VersionedSectionInfo.plist`),
+ * which keeps the notifications settings of every app as one archived `BBSectionInfo` per bundle id.
+ */
+export class BulletinBoardStore {
+    path;
+    models;
+    /**
+     * @param dataPath — data directory of the device
+     * @param versions — the `sectionInfoVersionNumber`s supported by the runtime, the oldest first
+     * (all the known ones by default). A store of any other version is refused, as the format may
+     * change in a future runtime. A missing store (a never-booted device) is created in the first
+     * one, as SpringBoard migrates older versions but not newer ones.
+     * @throws {Error} if a version is unknown
+     */
+    constructor(dataPath, versions = KNOWN_MODELS.map(({ version }) => version)) {
+        this.models = versions.map((version) => {
+            const model = KNOWN_MODELS.find((m) => m.version === version);
+            if (!model) {
+                throw new Error(`Unknown BulletinBoard store version ${version}`);
+            }
+            return model;
+        });
+        this.path = path.join(dataPath, 'Library', 'BulletinBoard', 'VersionedSectionInfo.plist');
+    }
+    /**
+     * Runs `update` once every earlier update of the same store has settled: concurrent updates for
+     * different apps would otherwise read the same store, and the last write would drop the other app's
+     * section. Only the calls made by this process are serialized.
+     */
+    async withLock(update) {
+        const result = (pendingUpdates.get(this.path) ?? Promise.resolve()).then(update);
+        const settled = result.then(() => { }, () => { });
+        pendingUpdates.set(this.path, settled);
+        try {
+            return await result;
+        }
+        finally {
+            if (pendingUpdates.get(this.path) === settled) {
+                pendingUpdates.delete(this.path);
+            }
+        }
+    }
+    /**
+     * Adds, replaces or (`unset`) removes the app's section. The store is replaced atomically, so a
+     * failed write leaves the previous one intact. A device that has never been booted has no store
+     * yet: it is created with just this section, and SpringBoard adds the rest on boot.
+     *
+     * @returns `false` if there was nothing to write (`unset` without a store)
+     * @throws {Error} if the existing store is of an unsupported format version
+     */
+    async setNotificationsStatus(bundleId, status) {
+        let store;
+        let model;
+        if (await fs.exists(this.path)) {
+            store = (await plist.parsePlistFile(this.path));
+            model = this.modelOf(store);
+        }
+        else if (status === 'unset') {
+            return false;
+        }
+        else {
+            await fs.mkdir(path.dirname(this.path), { recursive: true });
+            model = this.models[0];
+            store = model.createStore();
+        }
+        model.setNotificationsStatus(store, bundleId, status);
+        await this.replace(store);
+        return true;
+    }
+    /**
+     * Makes the store immutable (`uchg`) so that nothing, including a dying SpringBoard, can rewrite it.
+     * Best effort.
+     */
+    async setImmutable(immutable) {
+        try {
+            await execFileAsync('chflags', [immutable ? 'uchg' : 'nouchg', this.path]);
+        }
+        catch { }
+    }
+    modelOf(store) {
+        const model = this.models.find(({ version }) => version === store.sectionInfoVersionNumber);
+        if (!model) {
+            throw new Error(`Unsupported version of ${this.path}: sectionInfoVersionNumber is ${store.sectionInfoVersionNumber}, ` +
+                `supported: ${this.models.map(({ version }) => version).join(', ')}`);
+        }
+        return model;
+    }
+    async replace(store) {
+        // In the same directory, so that the rename is atomic.
+        const tmpPath = `${this.path}.${randomUUID()}.tmp`;
+        try {
+            await fs.writeFile(tmpPath, plist.createPlist(store, false), { flag: 'wx' });
+            await fs.rename(tmpPath, this.path);
+        }
+        catch (err) {
+            await fs.unlink(tmpPath).catch(() => { });
+            throw err;
+        }
+    }
+}
+//# sourceMappingURL=bulletin-board-store.js.map

package/lib/src/utils/bulletin-board-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulletin-board-store.js","sourceRoot":"","sources":["../../../src/utils/bulletin-board-store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAC,UAAU,EAAC,MAAM,aAAa,CAAC;AACvC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAC,SAAS,EAAC,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAC,EAAE,EAAE,KAAK,EAAC,MAAM,iBAAiB,CAAC;AAE1C,OAAO,EAAC,oBAAoB,EAAC,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAC,oBAAoB,EAAC,MAAM,8BAA8B,CAAC;AAGlE,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;AAE1C,+CAA+C;AAC/C,MAAM,YAAY,GAAkC,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,CAAC;AAEjG,0EAA0E;AAC1E,MAAM,cAAc,GAAG,IAAI,GAAG,EAAyB,CAAC;AAExD;;;GAGG;AACH,MAAM,OAAO,kBAAkB;IACpB,IAAI,CAAS;IACL,MAAM,CAAgC;IAEvD;;;;;;;OAOG;IACH,YAAY,QAAgB,EAAE,WAA8B,YAAY,CAAC,GAAG,CAAC,CAAC,EAAC,OAAO,EAAC,EAAE,EAAE,CAAC,OAAO,CAAC;QAClG,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YACrC,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;YAC9D,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,MAAM,IAAI,KAAK,CAAC,uCAAuC,OAAO,EAAE,CAAC,CAAC;YACpE,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,EAAE,eAAe,EAAE,4BAA4B,CAAC,CAAC;IAC5F,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ,CAAI,MAAwB;QACxC,MAAM,MAAM,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjF,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,GAAG,EAAE,GAAE,CAAC,EACR,GAAG,EAAE,GAAE,CAAC,CACT,CAAC;QACF,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACvC,IAAI,CAAC;YACH,OAAO,MAAM,MAAM,CAAC;QACtB,CAAC;gBAAS,CAAC;YACT,IAAI,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,OAAO,EAAE,CAAC;gBAC9C,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,sBAAsB,CAAC,QAAgB,EAAE,MAA2B;QACxE,IAAI,KAAgC,CAAC;QACrC,IAAI,KAAyB,CAAC;QAC9B,IAAI,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/B,KAAK,GAAG,CAAC,MAAM,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAA8B,CAAC;YAC7E,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;aAAM,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC;QACf,CAAC;aAAM,CAAC;YACN,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;YAC3D,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACvB,KAAK,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAC9B,CAAC;QACD,KAAK,CAAC,sBAAsB,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QACtD,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAAC,SAAkB;QACnC,IAAI,CAAC;YACH,MAAM,aAAa,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7E,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACZ,CAAC;IAEO,OAAO,CAAC,KAAgC;QAC9C,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAC,OAAO,EAAC,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC1F,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CACb,0BAA0B,IAAI,CAAC,IAAI,iCAAiC,KAAK,CAAC,wBAAwB,IAAI;gBACpG,cAAc,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAC,OAAO,EAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACrE,CAAC;QACJ,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,KAAgC;QACpD,uDAAuD;QACvD,MAAM,OAAO,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,UAAU,EAAE,MAAM,CAAC;QACnD,IAAI,CAAC;YACH,MAAM,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,EAAC,IAAI,EAAE,IAAI,EAAC,CAAC,CAAC;YAC3E,MAAM,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACtC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YACzC,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;CACF"}

package/lib/src/utils/index.d.ts

@@ -1,4 +1,7 @@
 export { getPkgRoot, PACKAGE_NAME } from './pkg-root.js';
 export { runCatchingAsync, toTypedError } from './run-catching.js';
 export { resolveDisplayPortId, validateDisplayId } from './display.js';
+export { BulletinBoardStore } from './bulletin-board-store.js';
+export type { NotificationsStatus } from './bulletin-board-model.js';
+export { SpringBoard } from './springboard.js';
 //# sourceMappingURL=index.d.ts.map

package/lib/src/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,YAAY,EAAC,MAAM,eAAe,CAAC;AACvD,OAAO,EAAC,gBAAgB,EAAE,YAAY,EAAC,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAC,oBAAoB,EAAE,iBAAiB,EAAC,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,YAAY,EAAC,MAAM,eAAe,CAAC;AACvD,OAAO,EAAC,gBAAgB,EAAE,YAAY,EAAC,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAC,oBAAoB,EAAE,iBAAiB,EAAC,MAAM,cAAc,CAAC;AACrE,OAAO,EAAC,kBAAkB,EAAC,MAAM,2BAA2B,CAAC;AAC7D,YAAY,EAAC,mBAAmB,EAAC,MAAM,2BAA2B,CAAC;AACnE,OAAO,EAAC,WAAW,EAAC,MAAM,kBAAkB,CAAC"}

package/lib/src/utils/index.js

@@ -1,4 +1,6 @@
 export { getPkgRoot, PACKAGE_NAME } from './pkg-root.js';
 export { runCatchingAsync, toTypedError } from './run-catching.js';
 export { resolveDisplayPortId, validateDisplayId } from './display.js';
+export { BulletinBoardStore } from './bulletin-board-store.js';
+export { SpringBoard } from './springboard.js';
 //# sourceMappingURL=index.js.map

package/lib/src/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,YAAY,EAAC,MAAM,eAAe,CAAC;AACvD,OAAO,EAAC,gBAAgB,EAAE,YAAY,EAAC,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAC,oBAAoB,EAAE,iBAAiB,EAAC,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,YAAY,EAAC,MAAM,eAAe,CAAC;AACvD,OAAO,EAAC,gBAAgB,EAAE,YAAY,EAAC,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAC,oBAAoB,EAAE,iBAAiB,EAAC,MAAM,cAAc,CAAC;AACrE,OAAO,EAAC,kBAAkB,EAAC,MAAM,2BAA2B,CAAC;AAE7D,OAAO,EAAC,WAAW,EAAC,MAAM,kBAAkB,CAAC"}

package/lib/src/utils/springboard.d.ts

@@ -0,0 +1,26 @@
+import type { NativeSimctl } from '../native-simctl.js';
+/**
+ * SpringBoard of a booted device: the process that owns the BulletinBoard store, see
+ * setNotificationsAccess. The simulator shares the host kernel, so it is signalled directly.
+ */
+export declare class SpringBoard {
+    private readonly simctl;
+    private readonly udid;
+    private pausedPid;
+    constructor(simctl: NativeSimctl, udid: string);
+    /**
+     * Pauses the running SpringBoard so that it cannot rewrite the BulletinBoard store. It can be in
+     * the middle of a restart, hence the retries.
+     */
+    pause(): Promise<void>;
+    /** Lets the paused SpringBoard run again. */
+    resume(): void;
+    /**
+     * Replaces the paused SpringBoard with a new one: asks launchd to stop it (launchd starts a new
+     * one right away), resumes it so that it can exit, then waits for the new process.
+     */
+    restart(): Promise<void>;
+    private pid;
+    private stop;
+}
+//# sourceMappingURL=springboard.d.ts.map

package/lib/src/utils/springboard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"springboard.d.ts","sourceRoot":"","sources":["../../../src/utils/springboard.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,qBAAqB,CAAC;AAKtD;;;GAGG;AACH,qBAAa,WAAW;IAIpB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,IAAI;IAJvB,OAAO,CAAC,SAAS,CAAqB;gBAGnB,MAAM,EAAE,YAAY,EACpB,IAAI,EAAE,MAAM;IAG/B;;;OAGG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAkB5B,6CAA6C;IAC7C,MAAM,IAAI,IAAI;IAMd;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;YAqBhB,GAAG;YAIH,IAAI;CAwBnB"}

package/lib/src/utils/springboard.js

@@ -0,0 +1,106 @@
+import { once } from 'node:events';
+import { waitForCondition } from 'asyncbox';
+const SPRINGBOARD_SERVICE = 'com.apple.SpringBoard';
+const SPRINGBOARD_RESTART_TIMEOUT_MS = 30000;
+/**
+ * SpringBoard of a booted device: the process that owns the BulletinBoard store, see
+ * setNotificationsAccess. The simulator shares the host kernel, so it is signalled directly.
+ */
+export class SpringBoard {
+    simctl;
+    udid;
+    pausedPid;
+    constructor(simctl, udid) {
+        this.simctl = simctl;
+        this.udid = udid;
+    }
+    /**
+     * Pauses the running SpringBoard so that it cannot rewrite the BulletinBoard store. It can be in
+     * the middle of a restart, hence the retries.
+     */
+    async pause() {
+        try {
+            await waitForCondition(async () => {
+                const pid = await this.pid().catch(() => undefined);
+                if (pid && sendSignal(pid, 'SIGSTOP')) {
+                    this.pausedPid = pid;
+                }
+                return Boolean(this.pausedPid);
+            }, { waitMs: SPRINGBOARD_RESTART_TIMEOUT_MS, intervalMs: 300 });
+        }
+        catch { }
+        if (!this.pausedPid) {
+            throw new Error(`${SPRINGBOARD_SERVICE} is not running`);
+        }
+    }
+    /** Lets the paused SpringBoard run again. */
+    resume() {
+        if (this.pausedPid) {
+            sendSignal(this.pausedPid, 'SIGCONT');
+        }
+    }
+    /**
+     * Replaces the paused SpringBoard with a new one: asks launchd to stop it (launchd starts a new
+     * one right away), resumes it so that it can exit, then waits for the new process.
+     */
+    async restart() {
+        const previousPid = this.pausedPid;
+        try {
+            await this.stop();
+        }
+        finally {
+            this.resume();
+            this.pausedPid = undefined;
+        }
+        try {
+            await waitForCondition(async () => {
+                const pid = await this.pid().catch(() => undefined);
+                return Number.isInteger(pid) && pid !== previousPid;
+            }, { waitMs: SPRINGBOARD_RESTART_TIMEOUT_MS, intervalMs: 300 });
+        }
+        catch {
+            throw new Error(`${SPRINGBOARD_SERVICE} did not restart within ${SPRINGBOARD_RESTART_TIMEOUT_MS}ms`);
+        }
+    }
+    async pid() {
+        return (await this.simctl.listProcesses(this.udid)).find(({ name }) => name === SPRINGBOARD_SERVICE)?.pid;
+    }
+    async stop() {
+        // Bare name: resolved against the guest runtime's own bin dirs, like in listProcesses.
+        const proc = await this.simctl.spawnProcess(this.udid, 'launchctl', {
+            arguments: ['launchctl', 'stop', SPRINGBOARD_SERVICE],
+        });
+        let stderr = '';
+        proc.stdout.resume();
+        proc.stderr.on('data', (chunk) => {
+            stderr += chunk;
+        });
+        const streamError = Promise.race([once(proc.stdout, 'error'), once(proc.stderr, 'error')]).then(([err]) => {
+            throw err;
+        });
+        const [[code, signal]] = await Promise.race([
+            Promise.all([once(proc, 'exit'), once(proc.stderr, 'end')]),
+            streamError,
+        ]);
+        if (code !== 0) {
+            const reason = signal ? `signal ${signal}` : `exit code ${code}`;
+            throw new Error(`'launchctl stop ${SPRINGBOARD_SERVICE}' failed with ${reason}${stderr.trim() ? `: ${stderr.trim()}` : ''}`);
+        }
+    }
+}
+/**
+ * @returns `false` if the process no longer exists
+ */
+function sendSignal(pid, name) {
+    try {
+        process.kill(pid, name);
+        return true;
+    }
+    catch (err) {
+        if (err?.code === 'ESRCH') {
+            return false;
+        }
+        throw err;
+    }
+}
+//# sourceMappingURL=springboard.js.map

package/lib/src/utils/springboard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"springboard.js","sourceRoot":"","sources":["../../../src/utils/springboard.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,aAAa,CAAC;AAEjC,OAAO,EAAC,gBAAgB,EAAC,MAAM,UAAU,CAAC;AAI1C,MAAM,mBAAmB,GAAG,uBAAuB,CAAC;AACpD,MAAM,8BAA8B,GAAG,KAAK,CAAC;AAE7C;;;GAGG;AACH,MAAM,OAAO,WAAW;IAIH;IACA;IAJX,SAAS,CAAqB;IAEtC,YACmB,MAAoB,EACpB,IAAY;QADZ,WAAM,GAAN,MAAM,CAAc;QACpB,SAAI,GAAJ,IAAI,CAAQ;IAC5B,CAAC;IAEJ;;;OAGG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,CAAC;YACH,MAAM,gBAAgB,CACpB,KAAK,IAAI,EAAE;gBACT,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;gBACpD,IAAI,GAAG,IAAI,UAAU,CAAC,GAAG,EAAE,SAAS,CAAC,EAAE,CAAC;oBACtC,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC;gBACvB,CAAC;gBACD,OAAO,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACjC,CAAC,EACD,EAAC,MAAM,EAAE,8BAA8B,EAAE,UAAU,EAAE,GAAG,EAAC,CAC1D,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;QACV,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,GAAG,mBAAmB,iBAAiB,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED,6CAA6C;IAC7C,MAAM;QACJ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,UAAU,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO;QACX,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QACpB,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,MAAM,EAAE,CAAC;YACd,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC7B,CAAC;QACD,IAAI,CAAC;YACH,MAAM,gBAAgB,CACpB,KAAK,IAAI,EAAE;gBACT,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;gBACpD,OAAO,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,GAAG,KAAK,WAAW,CAAC;YACtD,CAAC,EACD,EAAC,MAAM,EAAE,8BAA8B,EAAE,UAAU,EAAE,GAAG,EAAC,CAC1D,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,KAAK,CAAC,GAAG,mBAAmB,2BAA2B,8BAA8B,IAAI,CAAC,CAAC;QACvG,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,GAAG;QACf,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAC,IAAI,EAAC,EAAE,EAAE,CAAC,IAAI,KAAK,mBAAmB,CAAC,EAAE,GAAG,CAAC;IAC1G,CAAC;IAEO,KAAK,CAAC,IAAI;QAChB,uFAAuF;QACvF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE;YAClE,SAAS,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,mBAAmB,CAAC;SACtD,CAAC,CAAC;QACH,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACrB,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;YACvC,MAAM,IAAI,KAAK,CAAC;QAClB,CAAC,CAAC,CAAC;QACH,MAAM,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE;YACxG,MAAM,GAAG,CAAC;QACZ,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC;YAC1C,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;YAC3D,WAAW;SACZ,CAAC,CAAC;QACH,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;YACf,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,MAAM,EAAE,CAAC,CAAC,CAAC,aAAa,IAAI,EAAE,CAAC;YACjE,MAAM,IAAI,KAAK,CACb,mBAAmB,mBAAmB,iBAAiB,MAAM,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAC5G,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAED;;GAEG;AACH,SAAS,UAAU,CAAC,GAAW,EAAE,IAAoB;IACnD,IAAI,CAAC;QACH,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,IAAI,GAAG,EAAE,IAAI,KAAK,OAAO,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,GAAG,CAAC;IACZ,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/coresim",
-  "version": "1.13.0",
+  "version": "1.13.1",
   "description": "Native bindings to CoreSimulator.framework for Apple platform simulator control",
   "bugs": {
     "url": "https://github.com/appium/appium-ios/issues"
@@ -61,5 +61,6 @@
     "node": "^20.19.0 || ^22.12.0 || >=24.0.0",
     "npm": ">=10"
   },
-  "gypfile": true
+  "gypfile": true,
+  "gitHead": "9dce08cd8d4162196de0504f57500ec18f83b1c8"
 }