@push.rocks/smartpuppeteer 2.1.0 → 2.2.0

package/ts/smartpuppeteer.classes.smartpuppeteer.ts

@@ -2,10 +2,18 @@ import * as plugins from './smartpuppeteer.plugins.js';
 
 export interface IEnvAwareOptions {
   forceNoSandbox?: boolean;
+  requireSandbox?: boolean;
   usePipe?: boolean;
   launchOptions?: plugins.puppeteer.LaunchOptions;
 }
 
+const sandboxDisablingArguments = [
+  '--disable-gpu-sandbox',
+  '--disable-seccomp-filter-sandbox',
+  '--disable-setuid-sandbox',
+  '--no-sandbox',
+];
+
 export const resolveBrowserExecutablePath = (
   candidateNamesArg: string[] = [
     'google-chrome',
@@ -29,15 +37,30 @@ export const getEnvAwareBrowserInstance = async (
 ): Promise<plugins.puppeteer.Browser> => {
   const options: IEnvAwareOptions = {
     forceNoSandbox: false,
+    requireSandbox: false,
     ...optionsArg,
   };
 
+  if (options.forceNoSandbox && options.requireSandbox) {
+    throw new Error('forceNoSandbox and requireSandbox are mutually exclusive');
+  }
+
   const launchOptions = options.launchOptions ?? {};
   let chromeArgs: string[] = [...(launchOptions.args ?? [])];
-  if (
-    process.env.CI ||
-    options.forceNoSandbox ||
-    plugins.os.userInfo().username === 'root'
+  if (options.requireSandbox) {
+    const forbiddenArgument = chromeArgs.find((argument) => (
+      sandboxDisablingArguments.includes(argument.split('=', 1)[0]!)
+    ));
+    if (forbiddenArgument) {
+      throw new Error(`Sandbox-required browser launch rejects argument: ${forbiddenArgument}`);
+    }
+    if (process.platform === 'linux' && process.getuid?.() === 0) {
+      throw new Error('Sandbox-required Chromium cannot be launched as root');
+    }
+  } else if (
+    process.env.CI
+    || options.forceNoSandbox
+    || plugins.os.userInfo().username === 'root'
   ) {
     for (const sandboxArg of ['--no-sandbox', '--disable-setuid-sandbox']) {
       if (!chromeArgs.includes(sandboxArg)) {

package/ts/smartpuppeteer.interfaces.livebrowser.ts

@@ -23,6 +23,36 @@ export interface ILiveBrowserScreencastOptions {
   everyNthFrame?: number;
 }
 
+export interface ILiveBrowserSecurityOptions {
+  denyDownloads?: boolean;
+  denyFileChoosers?: boolean;
+  denyPermissions?: boolean;
+  httpNavigationOnly?: boolean;
+}
+
+export interface ILiveBrowserOperationOptions {
+  signal?: AbortSignal;
+}
+
+export type TLiveBrowserJsonValue =
+  | null
+  | boolean
+  | number
+  | string
+  | TLiveBrowserJsonValue[]
+  | { [key: string]: TLiveBrowserJsonValue };
+
+export interface ILiveBrowserEvaluateOptions {
+  tabId?: string;
+  timeoutMs?: number;
+  maxOutputBytes?: number;
+  maxDepth?: number;
+  maxNodes?: number;
+  maxStringBytes?: number;
+  maxArrayLength?: number;
+  maxObjectKeys?: number;
+}
+
 export type TLiveBrowserLaunchOptions = Omit<
   NonNullable<IEnvAwareOptions['launchOptions']>,
   'signal'
@@ -32,6 +62,8 @@ export interface ILiveBrowserSessionOptions extends Omit<IEnvAwareOptions, 'laun
   launchOptions?: TLiveBrowserLaunchOptions;
   viewport?: ILiveBrowserViewport;
   screencast?: ILiveBrowserScreencastOptions;
+  security?: ILiveBrowserSecurityOptions;
+  allowEvaluation?: boolean;
 }
 
 export interface ILiveBrowserTabState {