@efffrida/frida-tools 0.0.13 → 0.0.15

package/package.json

@@ -1,84 +1,70 @@
 {
   "name": "@efffrida/frida-tools",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "description": "Frida with effect-ts",
-  "license": "GPL-3.0-only",
+  "keywords": [
+    "frida.re",
+    "reverse engineering",
+    "effect-ts"
+  ],
+  "homepage": "https://github.com/leonitousconforti/efffrida",
   "repository": {
     "type": "git",
     "url": "https://github.com/leonitousconforti/efffrida.git",
     "directory": "packages/frida-tools"
   },
-  "sideEffects": [],
+  "license": "GPL-3.0-only",
   "author": "Leo Conforti <leo@leoconforti.us> (https://leoconforti.us)",
-  "homepage": "https://github.com/leonitousconforti/efffrida",
+  "sideEffects": [],
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": "./dist/index.ts",
+    "./*": "./dist/*.ts",
+    "./internal/*": null
+  },
+  "files": [
+    "src/**/*.ts",
+    "dist/**/*.js",
+    "dist/**/*.js.map",
+    "dist/**/*.d.ts",
+    "dist/**/*.d.ts.map"
+  ],
   "dependencies": {
-    "frida": "16.7.16"
+    "frida": "17.5.1"
+  },
+  "devDependencies": {
+    "@effect/cluster": "0.52.1",
+    "@effect/experimental": "0.57.0",
+    "@effect/platform": "0.93.0",
+    "@effect/platform-node": "0.100.0",
+    "@effect/rpc": "0.72.1",
+    "@effect/sql": "0.48.0",
+    "@effect/vitest": "0.27.0",
+    "@effect/workflow": "0.12.1",
+    "@types/frida-gum": "19.0.1",
+    "@types/node": "24.10.0",
+    "core-js": "3.46.0",
+    "effect": "3.19.0",
+    "vitest": "4.0.7"
   },
   "peerDependencies": {
-    "@effect/platform": "0.81.0",
-    "effect": "3.14.21"
+    "@effect/platform": "0.93.0",
+    "effect": "3.19.0"
   },
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.js",
-  "types": "./dist/dts/index.d.ts",
-  "exports": {
-    "./package.json": "./package.json",
-    ".": {
-      "types": "./dist/dts/index.d.ts",
-      "import": "./dist/esm/index.js",
-      "default": "./dist/cjs/index.js"
-    },
-    "./FridaDevice": {
-      "types": "./dist/dts/FridaDevice.d.ts",
-      "import": "./dist/esm/FridaDevice.js",
-      "default": "./dist/cjs/FridaDevice.js"
-    },
-    "./FridaDeviceAcquisitionError": {
-      "types": "./dist/dts/FridaDeviceAcquisitionError.d.ts",
-      "import": "./dist/esm/FridaDeviceAcquisitionError.js",
-      "default": "./dist/cjs/FridaDeviceAcquisitionError.js"
-    },
-    "./FridaScript": {
-      "types": "./dist/dts/FridaScript.d.ts",
-      "import": "./dist/esm/FridaScript.js",
-      "default": "./dist/cjs/FridaScript.js"
-    },
-    "./FridaSession": {
-      "types": "./dist/dts/FridaSession.d.ts",
-      "import": "./dist/esm/FridaSession.js",
-      "default": "./dist/cjs/FridaSession.js"
-    },
-    "./FridaSessionError": {
-      "types": "./dist/dts/FridaSessionError.d.ts",
-      "import": "./dist/esm/FridaSessionError.js",
-      "default": "./dist/cjs/FridaSessionError.js"
-    },
-    "./index": {
-      "types": "./dist/dts/index.d.ts",
-      "import": "./dist/esm/index.js",
-      "default": "./dist/cjs/index.js"
-    }
+  "publishConfig": {
+    "access": "public"
   },
-  "typesVersions": {
-    "*": {
-      "FridaDevice": [
-        "./dist/dts/FridaDevice.d.ts"
-      ],
-      "FridaDeviceAcquisitionError": [
-        "./dist/dts/FridaDeviceAcquisitionError.d.ts"
-      ],
-      "FridaScript": [
-        "./dist/dts/FridaScript.d.ts"
-      ],
-      "FridaSession": [
-        "./dist/dts/FridaSession.d.ts"
-      ],
-      "FridaSessionError": [
-        "./dist/dts/FridaSessionError.d.ts"
-      ],
-      "index": [
-        "./dist/dts/index.d.ts"
-      ]
-    }
+  "tags": [
+    "frida.re",
+    "reverse engineering",
+    "effect-ts"
+  ],
+  "scripts": {
+    "build": "tsc -b tsconfig.build.json && babel dist --plugins annotate-pure-calls --out-dir dist --source-maps",
+    "check": "tsc -b tsconfig.json",
+    "codegen": "build-utils prepare-v4",
+    "coverage": "vitest --coverage",
+    "test": "vitest"
   }
 }

package/src/FridaDevice.ts

@@ -4,13 +4,16 @@
  * @since 1.0.0
  */
 
+import type * as CommandExecutor from "@effect/platform/CommandExecutor";
+import type * as ConfigError from "effect/ConfigError";
 import type * as Context from "effect/Context";
 import type * as Effect from "effect/Effect";
 import type * as Layer from "effect/Layer";
+import type * as Scope from "effect/Scope";
 import type * as Frida from "frida";
-import type * as FridaDeviceAcquisitionError from "./FridaDeviceAcquisitionError.js";
+import type * as FridaDeviceAcquisitionError from "./FridaDeviceAcquisitionError.ts";
 
-import * as internal from "./internal/device.js";
+import * as internal from "./internal/device.ts";
 
 /**
  * @since 1.0.0
@@ -30,6 +33,7 @@ export type FridaDeviceTypeId = typeof FridaDeviceTypeId;
  */
 export interface FridaDevice {
     readonly device: Frida.Device;
+    readonly host: `usb://` | `local://` | `remote://${string}` | `android-emulator://${string}`;
     readonly [FridaDeviceTypeId]: typeof FridaDeviceTypeId;
 }
 
@@ -45,6 +49,16 @@ export const FridaDevice: Context.Tag<FridaDevice, FridaDevice> = internal.Tag;
  */
 export const isFridaDevice: (u: unknown) => u is FridaDevice = internal.isFridaDevice;
 
+/**
+ * @since 1.0.0
+ * @category Device acquisition
+ */
+export const acquireLocalDevice: () => Effect.Effect<
+    FridaDevice,
+    FridaDeviceAcquisitionError.FridaDeviceAcquisitionError,
+    never
+> = internal.acquireLocalDevice;
+
 /**
  * @since 1.0.0
  * @category Device acquisition
@@ -61,18 +75,58 @@ export const acquireUsbDevice: (
 export const acquireRemoteDevice: (
     address: string,
     options?: Frida.RemoteDeviceOptions | undefined
-) => Effect.Effect<FridaDevice, FridaDeviceAcquisitionError.FridaDeviceAcquisitionError, never> =
+) => Effect.Effect<FridaDevice, FridaDeviceAcquisitionError.FridaDeviceAcquisitionError, Scope.Scope> =
     internal.acquireRemoteDevice;
 
 /**
  * @since 1.0.0
  * @category Device acquisition
  */
-export const acquireLocalDevice: () => Effect.Effect<
+export const acquireAndroidEmulatorDevice: (
+    name: string,
+    options?:
+        | {
+              hidden?: boolean | undefined;
+              adbExecutable?: string | undefined;
+              fridaExecutable?: string | undefined;
+              emulatorExecutable?: string | undefined;
+              extraEmulatorArgs?: Array<string> | undefined;
+          }
+        | undefined
+) => Effect.Effect<
+    FridaDevice,
+    FridaDeviceAcquisitionError.FridaDeviceAcquisitionError,
+    CommandExecutor.CommandExecutor | Scope.Scope
+> = internal.acquireAndroidEmulatorDevice;
+
+/**
+ * @since 1.0.0
+ * @category Device acquisition
+ */
+export const acquireAndroidEmulatorDeviceConfig: (
+    name: string,
+    options?:
+        | {
+              hidden?: boolean | undefined;
+              fridaExecutable?: string | undefined;
+              extraEmulatorArgs?: Array<string> | undefined;
+          }
+        | undefined
+) => Effect.Effect<
+    FridaDevice,
+    ConfigError.ConfigError | FridaDeviceAcquisitionError.FridaDeviceAcquisitionError,
+    CommandExecutor.CommandExecutor | Scope.Scope
+> = internal.acquireAndroidEmulatorDeviceConfig;
+
+/**
+ * @since 1.0.0
+ * @category Layers
+ */
+export const layerLocalDevice: Layer.Layer<
     FridaDevice,
     FridaDeviceAcquisitionError.FridaDeviceAcquisitionError,
     never
-> = internal.acquireLocalDevice;
+> = internal.layerLocalDevice;
 
 /**
  * @since 1.0.0
@@ -96,8 +150,38 @@ export const layerUsbDevice: (
  * @since 1.0.0
  * @category Layers
  */
-export const layerLocalDevice: Layer.Layer<
+export const layerAndroidEmulatorDevice: (
+    name: string,
+    options?:
+        | {
+              hidden?: boolean | undefined;
+              adbExecutable?: string | undefined;
+              fridaExecutable?: string | undefined;
+              emulatorExecutable?: string | undefined;
+              extraEmulatorArgs?: Array<string> | undefined;
+          }
+        | undefined
+) => Layer.Layer<
     FridaDevice,
     FridaDeviceAcquisitionError.FridaDeviceAcquisitionError,
-    never
-> = internal.layerLocalDevice;
+    CommandExecutor.CommandExecutor
+> = internal.layerAndroidEmulatorDevice;
+
+/**
+ * @since 1.0.0
+ * @category Layers
+ */
+export const layerAndroidEmulatorDeviceConfig: (
+    name: string,
+    options?:
+        | {
+              hidden?: boolean | undefined;
+              fridaExecutable?: string | undefined;
+              extraEmulatorArgs?: Array<string> | undefined;
+          }
+        | undefined
+) => Layer.Layer<
+    FridaDevice,
+    ConfigError.ConfigError | FridaDeviceAcquisitionError.FridaDeviceAcquisitionError,
+    CommandExecutor.CommandExecutor
+> = internal.layerAndroidEmulatorDeviceConfig;

package/src/FridaDeviceAcquisitionError.ts

@@ -38,5 +38,9 @@ export class FridaDeviceAcquisitionError extends PlatformError.TypeIdError(
 )<{
     cause: unknown;
     attempts: number;
-    acquisitionMethod: "usb" | "remote" | "local";
-}> {}
+    acquisitionMethod: "usb" | "remote" | "local" | "android-emulator";
+}> {
+    public override get message(): string {
+        return `Failed to acquire ${this.acquisitionMethod} Frida device after ${this.attempts} attempt(s)`;
+    }
+}

package/src/FridaScript.ts

@@ -4,20 +4,23 @@
  * @since 1.0.0
  */
 
+import type * as Path from "@effect/platform/Path";
 import type * as Context from "effect/Context";
 import type * as Deferred from "effect/Deferred";
+import type * as Duration from "effect/Duration";
 import type * as Effect from "effect/Effect";
 import type * as Layer from "effect/Layer";
 import type * as Option from "effect/Option";
+import type * as ParseResult from "effect/ParseResult";
+import type * as Schema from "effect/Schema";
 import type * as Scope from "effect/Scope";
 import type * as Sink from "effect/Sink";
 import type * as Stream from "effect/Stream";
 import type * as Frida from "frida";
-import type * as FridaDevice from "./FridaDevice.js";
-import type * as FridaSession from "./FridaSession.js";
-import type * as FridaSessionError from "./FridaSessionError.js";
+import type * as FridaSession from "./FridaSession.ts";
+import type * as FridaSessionError from "./FridaSessionError.ts";
 
-import * as internal from "./internal/script.js";
+import * as internal from "./internal/script.ts";
 
 /**
  * @since 1.0.0
@@ -37,23 +40,25 @@ export type FridaScriptTypeId = typeof FridaScriptTypeId;
  */
 export interface FridaScript {
     readonly script: Frida.Script;
-    readonly destroyed: Deferred.Deferred<void, never>;
     readonly [FridaScriptTypeId]: typeof FridaScriptTypeId;
+    readonly destroyed: Deferred.Deferred<void, never>;
+    readonly scriptError: Deferred.Deferred<unknown, never>;
     readonly stream: Stream.Stream<
-        { message: any; data: Option.Option<Buffer> },
+        { message: unknown; data: Option.Option<Buffer> },
         FridaSessionError.FridaSessionError,
         never
     >;
     readonly sink: Sink.Sink<
         void,
-        { message: any; data: Option.Option<Buffer> },
+        { message: unknown; data: Option.Option<Buffer> },
         never,
         FridaSessionError.FridaSessionError,
         never
     >;
-    readonly callExport: (
-        exportName: string
-    ) => (...args: Array<any>) => Effect.Effect<unknown, FridaSessionError.FridaSessionError, never>;
+    readonly callExport: <A, I, R>(
+        exportName: string,
+        schema: Schema.Schema<A, I, R>
+    ) => (...args: Array<any>) => Effect.Effect<A, FridaSessionError.FridaSessionError | ParseResult.ParseError, R>;
 }
 
 /**
@@ -68,27 +73,54 @@ export const FridaScript: Context.Tag<FridaScript, FridaScript> = internal.Tag;
  */
 export const isFridaScript: (u: unknown) => u is FridaScript = internal.isFridaScript;
 
+/**
+ * @since 1.0.0
+ * @category Options
+ */
+export interface LoadOptions extends Frida.ScriptOptions, Frida.CompilerOptions {
+    readonly messageMailboxCapacity?:
+        | number
+        | {
+              readonly capacity?: number;
+              readonly strategy?: "suspend" | "dropping" | "sliding";
+          }
+        | undefined;
+    readonly streamShareOptions?:
+        | {
+              readonly capacity: "unbounded";
+              readonly replay?: number | undefined;
+              readonly idleTimeToLive?: Duration.DurationInput | undefined;
+          }
+        | {
+              readonly capacity: number;
+              readonly strategy?: "sliding" | "dropping" | "suspend" | undefined;
+              readonly replay?: number | undefined;
+              readonly idleTimeToLive?: Duration.DurationInput | undefined;
+          }
+        | undefined;
+}
+
 /**
  * @since 1.0.0
  * @category Frida
  */
 export const load: {
     (
-        source: string | Buffer,
-        options?: (Frida.ScriptOptions & { readonly resume?: boolean | undefined }) | undefined
+        entrypoint: URL,
+        options?: LoadOptions | undefined
     ): Effect.Effect<
         FridaScript,
         FridaSessionError.FridaSessionError,
-        FridaSession.FridaSession | FridaDevice.FridaDevice | Scope.Scope
+        Path.Path | FridaSession.FridaSession | Scope.Scope
     >;
     (
-        options?: (Frida.ScriptOptions & { readonly resume?: boolean | undefined }) | undefined
+        options?: LoadOptions | undefined
     ): (
-        source: string | Buffer
+        entrypoint: URL
     ) => Effect.Effect<
         FridaScript,
         FridaSessionError.FridaSessionError,
-        FridaSession.FridaSession | FridaDevice.FridaDevice | Scope.Scope
+        Path.Path | FridaSession.FridaSession | Scope.Scope
     >;
 } = internal.load;
 
@@ -98,20 +130,10 @@ export const load: {
  */
 export const layer: {
     (
-        source: string | Buffer,
-        options?: (Frida.ScriptOptions & { readonly resume?: boolean | undefined }) | undefined
-    ): Layer.Layer<
-        FridaScript,
-        FridaSessionError.FridaSessionError,
-        FridaDevice.FridaDevice | FridaSession.FridaSession
-    >;
+        entrypoint: URL,
+        options?: LoadOptions | undefined
+    ): Layer.Layer<FridaScript, FridaSessionError.FridaSessionError, FridaSession.FridaSession>;
     (
-        options?: (Frida.ScriptOptions & { readonly resume?: boolean | undefined }) | undefined
-    ): (
-        source: string | Buffer
-    ) => Layer.Layer<
-        FridaScript,
-        FridaSessionError.FridaSessionError,
-        FridaDevice.FridaDevice | FridaSession.FridaSession
-    >;
+        options?: LoadOptions | undefined
+    ): (entrypoint: URL) => Layer.Layer<FridaScript, FridaSessionError.FridaSessionError, FridaSession.FridaSession>;
 } = internal.layer;

package/src/FridaSession.ts

@@ -4,15 +4,16 @@
  * @since 1.0.0
  */
 
+import type * as Cause from "effect/Cause";
 import type * as Context from "effect/Context";
 import type * as Effect from "effect/Effect";
 import type * as Layer from "effect/Layer";
 import type * as Scope from "effect/Scope";
 import type * as Frida from "frida";
-import type * as FridaDevice from "./FridaDevice.js";
-import type * as FridaSessionError from "./FridaSessionError.js";
+import type * as FridaDevice from "./FridaDevice.ts";
+import type * as FridaSessionError from "./FridaSessionError.ts";
 
-import * as internal from "./internal/session.js";
+import * as internal from "./internal/session.ts";
 
 /**
  * @since 1.0.0
@@ -33,6 +34,14 @@ export type FridaSessionTypeId = typeof FridaSessionTypeId;
 export interface FridaSession {
     readonly session: Frida.Session;
     readonly [FridaSessionTypeId]: typeof FridaSessionTypeId;
+    readonly resume: Effect.Effect<void, Cause.UnknownException>;
+    readonly enableChildGating: Effect.Effect<void, Cause.UnknownException>;
+    readonly disableChildGating: Effect.Effect<void, Cause.UnknownException>;
+    setupPeerConnection(options?: Frida.PeerOptions | undefined): Effect.Effect<void, Cause.UnknownException>;
+    joinPortal(
+        address: string,
+        options?: Frida.PortalOptions | undefined
+    ): Effect.Effect<Frida.PortalMembership, Cause.UnknownException>;
 }
 
 /**
@@ -47,12 +56,21 @@ export const FridaSession: Context.Tag<FridaSession, FridaSession> = internal.Ta
  */
 export const isFridaSession: (u: unknown) => u is FridaSession = internal.isFridaSession;
 
+/**
+ * @since 1.0.0
+ * @category Frida
+ */
+export const frontmost: (
+    options?: Frida.FrontmostQueryOptions | undefined
+) => Effect.Effect<Frida.Application, FridaSessionError.FridaSessionError, FridaDevice.FridaDevice> =
+    internal.frontmost;
+
 /**
  * @since 1.0.0
  * @category Frida
  */
 export const spawn: (
-    program: string | Array<string>,
+    program: string | ReadonlyArray<string>,
     options?: Frida.SpawnOptions | undefined
 ) => Effect.Effect<number, FridaSessionError.FridaSessionError, FridaDevice.FridaDevice | Scope.Scope> = internal.spawn;
 
@@ -71,6 +89,14 @@ export const attach: (
  * @category Layers
  */
 export const layer: (
-    target: string,
+    target: number | string | ReadonlyArray<string>,
     options?: (Frida.SpawnOptions & Frida.SessionOptions) | undefined
 ) => Layer.Layer<FridaSession, FridaSessionError.FridaSessionError, FridaDevice.FridaDevice> = internal.layer;
+
+/**
+ * @since 1.0.0
+ * @category Layers
+ */
+export const layerFrontmost: (
+    options?: Frida.FrontmostQueryOptions | undefined
+) => Layer.Layer<FridaSession, FridaSessionError.FridaSessionError, FridaDevice.FridaDevice> = internal.layerFrontmost;

package/src/FridaSessionError.ts

@@ -36,7 +36,7 @@ export class FridaSessionError extends PlatformError.TypeIdError(FridaSessionErr
     cause: unknown;
     when: "spawn" | "kill" | "attach" | "detach" | "compile" | "load" | "unload" | "resume" | "message" | "rpcCall";
 }> {
-    get message() {
+    override get message() {
         return `A Frida session error occurred on ${this.when}`;
     }
 }

package/src/index.ts

@@ -1,34 +1,38 @@
+/**
+ * @since 1.0.0
+ */
+
 /**
  * Frida devices
  *
  * @since 1.0.0
  */
-export * as FridaDevice from "./FridaDevice.js"
+export * as FridaDevice from "./FridaDevice.ts"
 
 /**
  * Frida device acquisition errors
  *
  * @since 1.0.0
  */
-export * as FridaDeviceAcquisitionError from "./FridaDeviceAcquisitionError.js"
+export * as FridaDeviceAcquisitionError from "./FridaDeviceAcquisitionError.ts"
 
 /**
  * Frida scripts
  *
  * @since 1.0.0
  */
-export * as FridaScript from "./FridaScript.js"
+export * as FridaScript from "./FridaScript.ts"
 
 /**
  * Frida sessions
  *
  * @since 1.0.0
  */
-export * as FridaSession from "./FridaSession.js"
+export * as FridaSession from "./FridaSession.ts"
 
 /**
  * Frida session errors
  *
  * @since 1.0.0
  */
-export * as FridaSessionError from "./FridaSessionError.js"
+export * as FridaSessionError from "./FridaSessionError.ts"