@salesforce/b2c-tooling-sdk / operations/mrt / PushV2Options
Interface: PushV2Options
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:222
Options for pushing a v2-format bundle to MRT.
Extends
Properties
buildDirectory?
optionalbuildDirectory: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'Inherited from
CreateBundleV2Options.buildDirectory
bundleMetadata?
optionalbundleMetadata:BundleV2Metadata
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:513
Bundle metadata written into the config file (dependencies, ccOverrides).
Inherited from
CreateBundleV2Options.bundleMetadata
configPath?
optionalconfigPath: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'Inherited from
CreateBundleV2Options.configPath
matchMode?
optionalmatchMode: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'Inherited from
CreateBundleV2Options.matchMode
message?
optionalmessage: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.
Inherited from
origin?
optionalorigin:string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:232
MRT API origin URL.
Default
"https://cloud.mobify.com"projectDirectory?
optionalprojectDirectory: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()Inherited from
CreateBundleV2Options.projectDirectory
projectSlug
projectSlug:
string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:226
The project slug to upload to.
rootDir?
optionalrootDir: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'Inherited from
ssrOnly?
optionalssrOnly: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.
Inherited from
ssrParameters?
optionalssrParameters: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}.
Inherited from
CreateBundleV2Options.ssrParameters
ssrShared?
optionalssrShared: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.