@salesforce/b2c-tooling-sdk / operations/mrt
operations/mrt
Managed Runtime (MRT) operations.
This module provides functions for managing bundles and deployments on Salesforce Managed Runtime.
Bundle Operations
- createBundle - Create a bundle from a build directory
- pushBundle - Push a bundle to MRT (creates and uploads)
- uploadBundle - Upload a pre-created bundle
- listBundles - List bundles for a project
Usage
typescript
import { pushBundle } from '@salesforce/b2c-tooling-sdk/operations/mrt';
import { ApiKeyStrategy } from '@salesforce/b2c-tooling-sdk/auth';
const auth = new ApiKeyStrategy(process.env.MRT_API_KEY!, 'Authorization');
// Push and deploy a bundle
const result = await pushBundle({
projectSlug: 'my-storefront',
ssrOnly: ['ssr.js'],
ssrShared: ['**/*.js', 'static/**/*'],
buildDirectory: './build',
message: 'Release v1.0.0',
target: 'staging'
}, auth);
console.log(`Bundle ${result.bundleId} deployed to ${result.target}`);Authentication
MRT operations use API key authentication. Get your API key from the Runtime Admin dashboard.
Interfaces
- AccessControlBackendOptions
- AddMemberOptions
- AddOrgMemberOptions
- ApiKeyResult
- BulkDeleteBundlesOptions
- BulkDeleteBundlesResult
- BulkDeleteRejectedBundle
- Bundle
- BundleV2
- BundleV2Config
- BundleV2Metadata
- CloneEnvironmentBackendOptions
- CloneEnvironmentFlagsScapi
- CloneEnvOptions
- CloneRedirectsBackendOptions
- CloneRedirectsOptions
- CloneRedirectsResult
- CreateAccessControlHeaderBackendOptions
- CreateAccessControlHeaderOptions
- CreateBundleOptions
- CreateBundleV2Options
- CreateCertificateOptions
- CreateDeploymentOptions
- CreateDeploymentResult
- CreateDeploymentScapiResult
- CreateEnvironmentBackendOptions
- CreateEnvOptions
- CreateLoggingTokenOptions
- CreateNotificationOptions
- CreateProjectBackendOptions
- CreateProjectOptions
- CreateRedirectBackendOptions
- CreateRedirectOptions
- DeleteAccessControlHeaderBackendOptions
- DeleteAccessControlHeaderOptions
- DeleteBundleOptions
- DeleteCertificateOptions
- DeleteEnvironmentBackendOptions
- DeleteEnvOptions
- DeleteEnvVarBackendOptions
- DeleteEnvVarOptions
- DeleteNotificationOptions
- DeleteProjectBackendOptions
- DeleteProjectOptions
- DeleteRedirectBackendOptions
- DeleteRedirectOptions
- DeploymentScapiPollInfo
- DeployMrtBundleBackendOptions
- DownloadBundleOptions
- DownloadBundleResult
- EnvBackendOptions
- EnvironmentScapiPollInfo
- EnvironmentVariable
- EnvVarBackendOptions
- EnvVarOptions
- GetAccessControlHeaderBackendOptions
- GetAccessControlHeaderOptions
- GetB2COrgInfoOptions
- GetB2CTargetInfoOptions
- GetCertificateOptions
- GetEnvironmentBackendOptions
- GetEnvOptions
- GetMemberOptions
- GetNotificationOptions
- GetOrgMemberOptions
- GetProjectBackendOptions
- GetProjectOptions
- GetRedirectBackendOptions
- GetRedirectOptions
- InvalidateCacheBackendOptions
- InvalidateCacheOptions
- InvalidateCacheResult
- ListAccessControlHeadersBackendOptions
- ListAccessControlHeadersOptions
- ListAccessControlHeadersResult
- ListBundlesOptions
- ListBundlesResult
- ListCertificatesOptions
- ListCertificatesResult
- ListDeploymentsOptions
- ListDeploymentsResult
- ListEnvironmentsBackendOptions
- ListEnvsOptions
- ListEnvsResult
- ListEnvVarsResult
- ListMembersOptions
- ListMembersResult
- ListMrtBundlesBackendOptions
- ListMrtDeploymentsBackendOptions
- ListNotificationsOptions
- ListNotificationsResult
- ListOrganizationsOptions
- ListOrganizationsResult
- ListOrgMembersOptions
- ListOrgMembersResult
- ListProjectsBackendOptions
- ListProjectsOptions
- ListProjectsResult
- ListRedirectsBackendOptions
- ListRedirectsOptions
- ListRedirectsResult
- MrtAccessControlHeaderResult
- MrtAccessControlHeadersView
- MrtAccessControlHeaderView
- MrtAccessControlWriteResult
- MrtBackendBranches
- MrtBackendRun
- MrtBundlesView
- MrtBundleView
- MrtCacheInvalidationResult
- MrtDeploymentsView
- MrtDeploymentView
- MrtDeployResultView
- MrtEnvironmentResult
- MrtEnvironmentsView
- MrtEnvironmentView
- MrtEnvironmentWriteResult
- MrtEnvVarsView
- MrtEnvVarView
- MrtEnvVarWriteResult
- MrtLogEntry
- MrtProjectResult
- MrtProjectsView
- MrtProjectView
- MrtProjectWriteResult
- MrtPushResultView
- MrtRedirectCloneResult
- MrtRedirectResult
- MrtRedirectsView
- MrtRedirectView
- MrtRedirectWriteResult
- MrtServerConfig
- ProjectBackendOptions
- PushMrtBundleBackendOptions
- PushOptions
- PushResult
- PushV2Options
- PushV2Result
- RedirectBackendOptions
- RemoveMemberOptions
- RemoveOrgMemberOptions
- RestartCertificateValidationOptions
- RunMrtWithFallbackOptions
- ScapiMrtConnection
- ScapiRedirectInput
- SetB2CTargetInfoOptions
- SetEnvVarBackendOptions
- SetEnvVarOptions
- SetEnvVarsBackendOptions
- SetEnvVarsOptions
- SetPrimaryEnvironmentBackendOptions
- TailMrtLogsOptions
- TailMrtLogsResult
- UpdateB2CTargetInfoOptions
- UpdateEmailPreferencesOptions
- UpdateEnvironmentBackendOptions
- UpdateEnvOptions
- UpdateMemberOptions
- UpdateNotificationOptions
- UpdateOrgMemberOptions
- UpdateProjectBackendOptions
- UpdateProjectOptions
- UpdateRedirectBackendOptions
- UpdateRedirectOptions
- UploadBundleScapiResult
- UserOperationOptions
- WaitForDeploymentScapiOptions
- WaitForEnvironmentScapiOptions
- WaitForEnvOptions
- WaitForEnvPollInfo
Type Aliases
- BundleV2MatchMode
- MemberRoleValue
- MrtAccessControlHeader
- MrtBackend
- MrtBackendPreference
- MrtBundle
- MrtCertificate
- MrtCertificateListCreate
- MrtDeployment
- MrtDeploymentCreate
- MrtEmailNotification
- MrtEmailPreferences
- MrtEnvironment
- MrtEnvironmentState
- MrtEnvironmentUpdate
- MrtMember
- MrtNotification
- MrtOrganization
- MrtOrgMember
- MrtOrgMemberCreate
- MrtOrgMemberUpdate
- MrtProject
- MrtProjectUpdate
- MrtRedirect
- MrtUserProfile
- OrganizationLimits
- OrgCertPermission
- OrgRoleValue
- PatchedMrtEmailPreferences
- PatchedMrtEnvironment
- PatchedMrtMember
- PatchedMrtNotification
- PatchedMrtProject
- PatchedMrtRedirect
- RedirectHttpStatusCode
- SsrRegion
Variables
- DEFAULT_SSR_ONLY
- DEFAULT_SSR_PARAMETERS
- DEFAULT_SSR_SHARED
- DEFAULT_V2_CONFIG_PATH
- DEFAULT_V2_MATCH_MODE
- DEFAULT_V2_ROOT_DIR
- MEMBER_ROLES
- ORG_ROLES
Functions
- addMember
- addOrgMember
- bulkDeleteBundles
- cloneEnv
- cloneEnvironmentScapi
- cloneEnvironmentWithBackend
- cloneRedirects
- cloneRedirectsScapi
- cloneRedirectsWithBackend
- createAccessControlHeader
- createAccessControlHeaderScapi
- createAccessControlHeaderWithBackend
- createBundle
- createBundleV2
- createCacheInvalidationScapi
- createCertificate
- createDeployment
- createDeploymentScapi
- createEnv
- createEnvironmentScapi
- createEnvironmentWithBackend
- createGlobFilter
- createLoggingToken
- createNotification
- createProject
- createProjectWithBackend
- createRedirect
- createRedirectScapi
- createRedirectWithBackend
- createStorefrontScapi
- deleteAccessControlHeader
- deleteAccessControlHeaderScapi
- deleteAccessControlHeaderWithBackend
- deleteBundle
- deleteCertificate
- deleteEnv
- deleteEnvironmentScapi
- deleteEnvironmentWithBackend
- deleteEnvVar
- deleteEnvVarWithBackend
- deleteNotification
- deleteProject
- deleteProjectWithBackend
- deleteRedirect
- deleteRedirectScapi
- deleteRedirectWithBackend
- deleteStorefrontScapi
- deployMrtBundle
- downloadBundle
- getAccessControlHeader
- getAccessControlHeaderScapi
- getAccessControlHeadersScapi
- getAccessControlHeaderWithBackend
- getB2COrgInfo
- getB2CTargetInfo
- getCertificate
- getDefaultMessage
- getDeploymentScapi
- getEmailPreferences
- getEnv
- getEnvironmentByIdScapi
- getEnvironmentsScapi
- getEnvironmentVariablesScapi
- getEnvironmentWithBackend
- getLogsWebSocketUrl
- getMember
- getNotification
- getOrgMember
- getProfile
- getProject
- getProjectWithBackend
- getRedirect
- getRedirectScapi
- getRedirectsScapi
- getRedirectWithBackend
- getStorefrontByIdScapi
- getStorefrontsScapi
- invalidateCache
- invalidateCacheWithBackend
- listAccessControlHeaders
- listAccessControlHeadersWithBackend
- listBundles
- listBundlesScapi
- listCertificates
- listDeployments
- listDeploymentsScapi
- listEnvironmentsWithBackend
- listEnvs
- listEnvVars
- listEnvVarsWithBackend
- listMembers
- listMrtBundles
- listMrtDeployments
- listNotifications
- listOrganizations
- listOrgMembers
- listProjects
- listProjectsWithBackend
- listRedirects
- listRedirectsWithBackend
- mrtScapiUnavailableMessage
- normalizeAccessControlHeaderScapi
- normalizeDeploymentScapi
- normalizeEnvironmentScapi
- normalizeEnvVarScapi
- normalizeLegacyAccessControlHeader
- normalizeLegacyBundle
- normalizeLegacyDeployment
- normalizeLegacyEnv
- normalizeLegacyEnvVar
- normalizeLegacyProject
- normalizeLegacyRedirect
- normalizeProjectScapi
- normalizeRedirectScapi
- normalizeScapiBundle
- parseMrtLogLine
- pushBundle
- pushBundleV2
- pushMrtBundle
- removeMember
- removeOrgMember
- resetApiKey
- resolveMrtBackend
- restartCertificateValidation
- runMrtWithFallback
- setB2CTargetInfo
- setEnvVar
- setEnvVars
- setEnvVarsWithBackend
- setEnvVarWithBackend
- setPrimaryEnvironmentScapi
- setPrimaryEnvironmentWithBackend
- tailMrtLogs
- updateB2CTargetInfo
- updateEmailPreferences
- updateEnv
- updateEnvironmentScapi
- updateEnvironmentVariablesScapi
- updateEnvironmentWithBackend
- updateMember
- updateNotification
- updateOrgMember
- updateProject
- updateProjectWithBackend
- updateRedirect
- updateRedirectScapi
- updateRedirectWithBackend
- updateStorefrontScapi
- uploadBundle
- uploadBundleScapi
- uploadBundleV2
- waitForDeploymentScapi
- waitForEnv
- waitForEnvironmentScapi
References
B2COrgInfo
Re-exports B2COrgInfo
B2CTargetInfo
Re-exports B2CTargetInfo
PatchedB2CTargetInfo
Re-exports PatchedB2CTargetInfo