@salesforce/b2c-tooling-sdk / operations/mrt / CreateBundleV2Options

Interface: CreateBundleV2Options

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:476

Configuration for v2 bundle archive creation.

Unlike v1, the archive layout has no project-slug prefix: built files sit directly under {rootDir}/ and the SSR configuration is written into the archive at {rootDir}/{configPath} rather than being sent as request fields.

Extended by

PushV2Options

Properties

buildDirectory?

optional buildDirectory: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:519

Path to the build directory containing the application build output.

Default

'build'

bundleMetadata?

optional bundleMetadata: BundleV2Metadata

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:513

Bundle metadata written into the config file (dependencies, ccOverrides).

configPath?

optional configPath: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:540

Path to the in-archive config file, relative to rootDir.

Default

'.mrt/config.json'

matchMode?

optional matchMode: BundleV2MatchMode

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:546

How the server handles ssrOnly/ssrShared patterns that match no files.

Default

'strict'

message?

optional message: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:481

Optional message describing the bundle. Defaults to a git-based message or a timestamp.

projectDirectory?

optional projectDirectory: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:528

Directory to read config.server.{ts,js} from when there is no on-disk v2 config file and ssrOnly/ssrShared are not provided explicitly. The config is read straight from source at bundle time (no build step) and its values are written into the bundle's in-archive config file.

Default

process.cwd()

rootDir?

optional rootDir: string

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:534

Archive path prefix under which built files and the config file live.

Default

'bld'

ssrOnly?

optional ssrOnly: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:498

Glob patterns for files that should only run on the server. Written verbatim into the config file; matched server-side against paths relative to rootDir. If omitted, read from the on-disk v2 config file ({buildDirectory}/{configPath}) if present, else the project's config.server.{ts,js}, else defaults.

ssrParameters?

optional ssrParameters: Record<string, unknown>

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:488

SSR parameters written into the in-archive config file. Merged over defaults and any values from the on-disk v2 config file ({buildDirectory}/{configPath}) or the project's config.server.{ts,js}.

ssrShared?

optional ssrShared: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:508

Glob patterns for files shared between client and server. Written verbatim into the config file; matched server-side against paths relative to rootDir. If omitted, read from the on-disk v2 config file ({buildDirectory}/{configPath}) if present, else the project's config.server.{ts,js}, else defaults.