Class SandboxNamespace

bim.sandbox — Secure script execution in QuickJS-WASM

Index

Constructors

Methods

create dispose eval evalTypeScript getApiSchema getDefaultLimits getDefaultPermissions transpile

Constructors

constructor

new SandboxNamespace(bimContext?: unknown): SandboxNamespace
Parameters
- OptionalbimContext: unknown
Returns SandboxNamespace

Methods

create

create(config?: SandboxConfig): Promise<unknown>
Create a sandboxed execution environment.

The sandbox runs scripts in an isolated QuickJS WASM instance with only the bim.* API exposed. No DOM, fetch, or network access.
Parameters
- Optionalconfig: SandboxConfig
  Permissions and resource limits
Returns Promise<unknown>
The sandbox instance (call dispose() when done)

dispose

dispose(): Promise<void>

Dispose the active sandbox and free WASM resources.

Returns Promise<void>

eval

eval(script: string, config?: SandboxConfig): Promise<ScriptResult>
Evaluate a script in the active sandbox. Creates a sandbox if none exists yet.
Parameters
- script: string
- Optionalconfig: SandboxConfig
Returns Promise<ScriptResult>

evalTypeScript

evalTypeScript(tsCode: string, config?: SandboxConfig): Promise<ScriptResult>
Evaluate TypeScript code (transpiles to JS first, then runs).
Parameters
- tsCode: string
- Optionalconfig: SandboxConfig
Returns Promise<ScriptResult>

getApiSchema

getApiSchema(): Promise<unknown>

Get the bim.* API schema exposed to sandboxed scripts.

Returns Promise<unknown>

getDefaultLimits

getDefaultLimits(): Promise<SandboxLimits>

Get default resource limits.

Returns Promise<SandboxLimits>

getDefaultPermissions

getDefaultPermissions(): Promise<SandboxPermissions>

Get default permissions.

Returns Promise<SandboxPermissions>

transpile

transpile(tsCode: string): Promise<string>
Transpile TypeScript to JavaScript without executing it.
Parameters
- tsCode: string
Returns Promise<string>