diff --git a/docs/README.md b/docs/README.md index 63b5ec9..882f394 100644 --- a/docs/README.md +++ b/docs/README.md @@ -102,7 +102,7 @@ An ID of a known permission on Android. #### Defined in -node_modules/appstraction/dist/index.d.ts:46 +node_modules/appstraction/dist/index.d.ts:68 ___ @@ -193,7 +193,7 @@ A supported attribute for the `getDeviceAttribute()` function, depending on the #### Defined in -node_modules/appstraction/dist/index.d.ts:363 +node_modules/appstraction/dist/index.d.ts:415 ___ @@ -212,7 +212,7 @@ The options for each attribute available through the `getDeviceAttribute()` func #### Defined in -node_modules/appstraction/dist/index.d.ts:365 +node_modules/appstraction/dist/index.d.ts:417 ___ @@ -224,7 +224,7 @@ An ID of a known permission on iOS. #### Defined in -node_modules/appstraction/dist/index.d.ts:50 +node_modules/appstraction/dist/index.d.ts:72 ___ @@ -428,6 +428,7 @@ Functions that are available for the platforms. | `installApp` | (`appPath`: `AppPath`<`Platform`\>, `obbPaths?`: `Platform` extends ``"android"`` ? `ObbInstallSpec`[] : `never`) => `Promise`<`void`\> | Install the app at the given path. | | `installCertificateAuthority` | (`path`: `string`) => `Promise`<`void`\> | Install the certificate authority with the given path as a trusted CA on the device. This allows you to intercept and modify traffic from apps on the device. On Android, this installs the CA as a system CA. As this is normally not possible on Android 10 and above, it overlays the `/system/etc/security/cacerts` directory with a tmpfs and installs the CA there. This means that the changes are not persistent across reboots. On iOS, the CA is installed permanently as a root certificate in the Certificate Trust Store. It persists across reboots.\ **Currently, you need to manually trust any CA at least once on the device, CAs can be added but not automatically marked as trusted (see: https://github.com/tweaselORG/appstraction/issues/44#issuecomment-1466151197).** Requires the `root` capability on Android, and the `ssh` capability on iOS. | | `isAppInstalled` | (`appId`: `string`) => `Promise`<`boolean`\> | Check whether the app with the given app ID is installed. | +| `listApps` | (`options?`: { `includeSystem?`: `boolean` }) => `Promise`<`string`[]\> | Get a list of the app IDs of all installed apps. | | `removeCertificateAuthority` | (`path`: `string`) => `Promise`<`void`\> | Remove the certificate authority with the given path from the trusted CAs on the device. On Android, this works for system CAs, including those pre-installed with the OS. As this is normally not possible on Android 10 and above, it overlays the `/system/etc/security/cacerts` directory with a tmpfs and removes the CA there. This means that the changes are not persistent across reboots. On iOS, this only works for CAs in the Certificate Trust Store. It does not work for pre-installed OS CAs. The changes are persistent across reboots. Requires the `root` capability on Android, and the `ssh` capability on iOS. | | `resetDevice` | `Platform` extends ``"android"`` ? `RunTarget` extends ``"emulator"`` ? (`snapshotName`: `string`) => `Promise`<`void`\> : `never` : `never` | Reset the device to the specified snapshot (only available for emulators). **`Param`** The name of the snapshot to reset to. | | `setAppBackgroundBatteryUsage` | `Platform` extends ``"android"`` ? (`appId`: `string`, `state`: ``"unrestricted"`` \| ``"optimized"`` \| ``"restricted"``) => `Promise`<`void`\> : `never` | Configure whether the app's background battery usage should be restricted. Currently only supported on Android. **`Param`** The app ID of the app to configure the background battery usage settings for. **`Param`** The state to set the background battery usage to. On Android, the possible values are: - `unrestricted`: "Allow battery usage in background without restrictions. May use more battery." - `optimized`: "Optimize based on your usage. Recommended for most apps." (default after installation) - `restricted`: "Restrict battery usage while in background. Apps may not work as expected. Notifications may be delayed." | @@ -444,7 +445,7 @@ Functions that are available for the platforms. #### Defined in -node_modules/appstraction/dist/index.d.ts:73 +node_modules/appstraction/dist/index.d.ts:95 ___ @@ -508,7 +509,7 @@ A platform that is supported by this library. #### Defined in -node_modules/appstraction/dist/index.d.ts:52 +node_modules/appstraction/dist/index.d.ts:74 ___ @@ -526,7 +527,7 @@ A run target that is supported by this library for the given platform. #### Defined in -node_modules/appstraction/dist/index.d.ts:54 +node_modules/appstraction/dist/index.d.ts:76 ___ @@ -554,7 +555,7 @@ The IDs of known permissions on Android. #### Defined in -node_modules/appstraction/dist/index.d.ts:44 +node_modules/appstraction/dist/index.d.ts:66 ___ @@ -566,7 +567,7 @@ The IDs of known permissions on iOS. #### Defined in -node_modules/appstraction/dist/index.d.ts:48 +node_modules/appstraction/dist/index.d.ts:70 ## Functions @@ -588,7 +589,7 @@ Pause for a given duration. #### Defined in -node_modules/appstraction/dist/index.d.ts:17 +node_modules/appstraction/dist/index.d.ts:18 ___ diff --git a/package.json b/package.json index 554c690..9555d23 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "cyanoacrylate", - "version": "0.6.3", + "version": "1.0.0", "description": "Toolkit for large-scale automated traffic analysis of mobile apps on Android and iOS.", "bugs": "https://github.com/tweaselORG/cyanoacrylate/issues", "repository": {