psfdx-metadata/psfdx-metadata.psm1
|
function Import-PsfdxSharedModule { [CmdletBinding()] param( [string] $ModuleName = 'psfdx-shared' ) if (Get-Module -Name $ModuleName -ErrorAction SilentlyContinue) { return } $candidates = @() $repoManifest = Join-Path -Path $PSScriptRoot -ChildPath (Join-Path '..' (Join-Path $ModuleName "$ModuleName.psd1")) $candidates += $repoManifest $moduleParent = Split-Path -Path $PSScriptRoot -Parent if ($moduleParent) { $siblingManifest = Join-Path -Path $moduleParent -ChildPath (Join-Path $ModuleName "$ModuleName.psd1") $candidates += $siblingManifest $moduleRoot = Split-Path -Path $moduleParent -Parent if ($moduleRoot) { $sharedBase = Join-Path -Path $moduleRoot -ChildPath $ModuleName if (Test-Path -LiteralPath $sharedBase) { try { $versionDirectories = Get-ChildItem -Path $sharedBase -Directory -ErrorAction Stop | Sort-Object -Property Name -Descending foreach ($dir in $versionDirectories) { $candidates += Join-Path -Path $dir.FullName -ChildPath "$ModuleName.psd1" } } catch { # ignore directory inspection failures } $candidates += Join-Path -Path $sharedBase -ChildPath "$ModuleName.psd1" } } } $available = Get-Module -ListAvailable -Name $ModuleName -ErrorAction SilentlyContinue | Sort-Object -Property Version -Descending foreach ($item in $available) { if ($item.Path) { $candidates += $item.Path } } foreach ($candidate in $candidates | Where-Object { $_ } | Select-Object -Unique) { if (Test-Path -LiteralPath $candidate) { Import-Module -Name $candidate -ErrorAction Stop return } } Import-Module -Name $ModuleName -ErrorAction Stop } Import-PsfdxSharedModule # The valid -Type values feed tab-completion and Assert-SalesforceMetadataType, and the org # round-trip behind them costs seconds, so they are resolved once per session. Call # Clear-SalesforceMetadataTypeCache after connecting to an org (or re-import the module) # to pick up types that were not visible when the cache was first populated. # -Type uses an ArgumentCompleter rather than [ValidateSet([Generator])] because # IValidateSetValuesGenerator needs PowerShell 6+ and this module supports 5.1. The completer # scriptblock runs in the caller's scope, so it calls back into the module to reach the private helper. $script:SalesforceMetadataTypeCache = $null function Complete-SalesforceMetadataType { Param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameters) Get-SalesforceMetadataTypeValidValues | Where-Object { $_ -like "$wordToComplete*" } | ForEach-Object { [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_) } } function Assert-SalesforceMetadataType { [CmdletBinding()] Param([Parameter(Mandatory = $true)][string] $Type) $validTypes = Get-SalesforceMetadataTypeValidValues if ($validTypes -notcontains $Type) { throw "Unknown metadata type '$Type'. Run Describe-SalesforceMetadataTypes to list valid types, or Clear-SalesforceMetadataTypeCache after connecting to a different org." } } function Get-SalesforceMetadataTypeValidValues { [CmdletBinding()] Param() if ($script:SalesforceMetadataTypeCache) { return $script:SalesforceMetadataTypeCache } $types = $null try { $types = Describe-SalesforceMetadataTypes } catch { Write-Verbose ("Could not list metadata types from the org: " + $_.Exception.Message) } if (-not $types -or (@($types).Count -eq 0)) { Write-Verbose "Falling back to the built-in metadata type list" $types = Get-SalesforceMetadataTypesDefault } $script:SalesforceMetadataTypeCache = (@($types) + 'CustomField', 'ValidationRule') | Where-Object { -not [string]::IsNullOrWhiteSpace($_) } | Sort-Object -Unique return $script:SalesforceMetadataTypeCache } function Clear-SalesforceMetadataTypeCache { [CmdletBinding()] Param() $script:SalesforceMetadataTypeCache = $null } function Get-SalesforceMetadataTypesDefault { [CmdletBinding()] Param() return @( 'AIApplication' 'AIApplicationConfig' 'ActionLauncherItemDef' 'ActionLinkGroupTemplate' 'AnalyticSnapshot' 'AnimationRule' 'ApexClass' 'ApexComponent' 'ApexEmailNotifications' 'ApexPage' 'ApexTestSuite' 'ApexTrigger' 'AppFrameworkTemplateBundle' 'AppMenu' 'AppointmentAssignmentPolicy' 'AppointmentSchedulingPolicy' 'ApprovalProcess' 'AssignmentRules' 'AuraDefinitionBundle' 'AuthProvider' 'AutoResponseRules' 'BlacklistedConsumer' 'BrandingSet' 'BriefcaseDefinition' 'CallCenter' 'CallCoachingMediaProvider' 'CanvasMetadata' 'Certificate' 'ChannelLayout' 'ChatterExtension' 'ChoiceList' 'CleanDataService' 'Community' 'ConnectedApp' 'ContentAsset' 'ContentTypeBundle' 'ConvIntelligenceSignalRule' 'ConversationMessageDefinition' 'CorsWhitelistOrigin' 'CspTrustedSite' 'CustomApplication' 'CustomApplicationComponent' 'CustomFeedFilter' 'CustomHelpMenuSection' 'CustomIndex' 'CustomLabels' 'CustomMetadata' 'CustomNotificationType' 'CustomObject' 'CustomObjectTranslation' 'CustomPageWebLink' 'CustomPermission' 'CustomSite' 'CustomTab' 'Dashboard' 'DataCategoryGroup' 'DataWeaveResource' 'DelegateGroup' 'DigitalExperienceBundle' 'Document' 'DuplicateRule' 'EclairGeoData' 'EmailServicesFunction' 'EmailTemplate' 'EmbeddedServiceBranding' 'EmbeddedServiceConfig' 'EmbeddedServiceFlowConfig' 'EmbeddedServiceMenuSettings' 'EscalationRules' 'EventRelayConfig' 'ExperienceContainer' 'ExperiencePropertyTypeBundle' 'ExternalAuthIdentityProvider' 'ExternalClientApplication' 'ExternalCredential' 'ExternalDataSource' 'ExternalServiceRegistration' 'ExtlClntAppConfigurablePolicies' 'ExtlClntAppGlobalOauthSettings' 'ExtlClntAppMobileConfigurablePolicies' 'ExtlClntAppMobileSettings' 'ExtlClntAppNotificationSettings' 'ExtlClntAppOauthConfigurablePolicies' 'ExtlClntAppOauthSettings' 'ExtlClntAppPushConfigurablePolicies' 'ExtlClntAppPushSettings' 'ExtlClntAppSamlConfigurablePolicies' 'FieldRestrictionRule' 'FlexiPage' 'Flow' 'FlowCategory' 'FlowDefinition' 'FlowTest' 'ForecastingFilter' 'ForecastingFilterCondition' 'ForecastingGroup' 'ForecastingSourceDefinition' 'ForecastingType' 'ForecastingTypeSource' 'GatewayProviderPaymentMethodType' 'GlobalValueSet' 'GlobalValueSetTranslation' 'Group' 'HomePageComponent' 'HomePageLayout' 'IPAddressRange' 'IframeWhiteListUrlSettings' 'InboundNetworkConnection' 'InstalledPackage' 'Layout' 'LeadConvertSettings' 'Letterhead' 'LightningBolt' 'LightningComponentBundle' 'LightningExperienceTheme' 'LightningMessageChannel' 'LightningOnboardingConfig' 'LightningTypeBundle' 'LiveChatSensitiveDataRule' 'MLDataDefinition' 'MLPredictionDefinition' 'MLRecommendationDefinition' 'ManagedContentType' 'ManagedEventSubscription' 'MatchingRules' 'MessagingChannel' 'MobileApplicationDetail' 'MutingPermissionSet' 'MyDomainDiscoverableLogin' 'NamedCredential' 'NetworkBranding' 'NotificationTypeConfig' 'OauthCustomScope' 'OauthTokenExchangeHandler' 'OutboundNetworkConnection' 'PathAssistant' 'PaymentGatewayProvider' 'PermissionSet' 'PermissionSetGroup' 'PlatformCachePartition' 'PlatformEventChannel' 'PlatformEventChannelMember' 'PlatformEventSubscriberConfig' 'PostTemplate' 'ProcessFlowMigration' 'ProductAttributeSet' 'Profile' 'ProfilePasswordPolicy' 'ProfileSessionSetting' 'Prompt' 'PublicKeyCertificate' 'PublicKeyCertificateSet' 'Queue' 'QuickAction' 'RecommendationStrategy' 'RecordActionDeployment' 'RedirectWhitelistUrl' 'RemoteSiteSetting' 'Report' 'ReportType' 'RestrictionRule' 'Role' 'SamlSsoConfig' 'Scontrol' 'SearchCustomization' 'SearchOrgWideObjectConfig' 'Settings' 'SharingRules' 'SharingSet' 'SiteDotCom' 'Skill' 'SkillType' 'StandardValueSet' 'StandardValueSetTranslation' 'StaticResource' 'SynonymDictionary' 'TopicsForObjects' 'TransactionSecurityPolicy' 'UiFormatSpecificationSet' 'UserProvisioningConfig' 'WaveAnalyticAssetCollection' 'Workflow' ) } #region Retrieve function Retrieve-SalesforceComponent { [CmdletBinding()] Param( [Parameter(Mandatory = $false)][ArgumentCompleter({ & (Get-Module psfdx-metadata -All | Select-Object -First 1) { Complete-SalesforceMetadataType @args } @args })][string] $Type, [Parameter(Mandatory = $false)][string] $Name, [Parameter(Mandatory = $false)][string] $ChildName, [Parameter(Mandatory = $false)][string] $TargetOrg, [Parameter(Mandatory = $false)][int] $Wait, [Parameter(Mandatory = $false)][string] $OutputDir, [Parameter(Mandatory = $false)][switch] $IgnoreConflicts ) if ($ChildName -and -not $Name) { throw "Specify -Name when using -ChildName." } if ([string]::IsNullOrWhiteSpace($Type)) { throw "Specify -Type when retrieving a component." } Assert-SalesforceMetadataType -Type $Type $command = "sf project retrieve start --metadata $Type" if ($Name) { $command += ":$Name" if ($ChildName) { $command += ".$ChildName" } } if ($PSBoundParameters.ContainsKey('TargetOrg') -and -not [string]::IsNullOrWhiteSpace($TargetOrg)) { $command += " --target-org $TargetOrg" } if ($PSBoundParameters.ContainsKey('Wait')) { $command += " --wait $Wait" } if ($OutputDir) { if (-not (Test-Path -Path $OutputDir -PathType Container)) { throw "Output directory '$OutputDir' does not exist." } $command += " --output-dir `"$OutputDir`"" } if ($IgnoreConflicts) { $command += " --ignore-conflicts" } $commonParams = Get-PsfdxCommonParameterSplat -BoundParameters $PSBoundParameters Invoke-Salesforce -Command $command @commonParams } function Retrieve-SalesforceMetadata { [CmdletBinding()] Param( [Parameter(Mandatory = $true)][string] $Manifest, [Parameter(Mandatory = $true)][string] $OutputDir, [Parameter(Mandatory = $false)][int] $Wait, [Parameter(Mandatory = $false)][switch] $Unzip, [Parameter(Mandatory = $false)][string] $TargetOrg ) if (-not (Test-Path -Path $Manifest -PathType Leaf)) { throw "Manifest file '$Manifest' does not exist." } if (-not (Test-Path -Path $OutputDir -PathType Container)) { throw "Output directory '$OutputDir' does not exist." } $command = "sf project retrieve start --manifest `"$Manifest`"" $command += " --target-metadata-dir `"$OutputDir`"" if ($PSBoundParameters.ContainsKey('Wait')) { $command += " --wait $Wait" } if ($Unzip) { $command += " --unzip" } if ($PSBoundParameters.ContainsKey('TargetOrg') -and -not [string]::IsNullOrWhiteSpace($TargetOrg)) { $command += " --target-org $TargetOrg" } $commonParams = Get-PsfdxCommonParameterSplat -BoundParameters $PSBoundParameters Invoke-Salesforce -Command $command @commonParams } function Retrieve-SalesforcePackage { [CmdletBinding()] Param( [Parameter(Mandatory = $true)][string] $Name, [Parameter(Mandatory = $true)][string] $OutputDir, [Parameter(Mandatory = $false)][int] $Wait, [Parameter(Mandatory = $false)][string] $TargetOrg ) if (-not (Test-Path -Path $OutputDir -PathType Container)) { throw "Output directory '$OutputDir' does not exist." } $command = "sf project retrieve start --package-name `"$Name`"" $command += " --output-dir `"$OutputDir`"" if ($PSBoundParameters.ContainsKey('Wait')) { $command += " --wait $Wait" } if ($PSBoundParameters.ContainsKey('TargetOrg') -and -not [string]::IsNullOrWhiteSpace($TargetOrg)) { $command += " --target-org $TargetOrg" } $commonParams = Get-PsfdxCommonParameterSplat -BoundParameters $PSBoundParameters Invoke-Salesforce -Command $command @commonParams } function Retrieve-SalesforceField { [CmdletBinding()] Param( [Parameter(Mandatory = $true)][string] $ObjectName, [Parameter(Mandatory = $true)][string] $FieldName, [Parameter(Mandatory = $false)][string] $TargetOrg) Retrieve-SalesforceComponent -Type 'CustomField' -Name $ObjectName -ChildName $FieldName -TargetOrg $TargetOrg } function Retrieve-SalesforceValidationRule { [CmdletBinding()] Param( [Parameter(Mandatory = $true)][string] $ObjectName, [Parameter(Mandatory = $true)][string] $RuleName, [Parameter(Mandatory = $false)][string] $TargetOrg) Retrieve-SalesforceComponent -Type 'ValidationRule' -Name $ObjectName -ChildName $RuleName -TargetOrg $TargetOrg } function Retrieve-SalesforceOrg { [CmdletBinding()] Param( [Parameter(Mandatory = $false)][string] $TargetOrg, [Parameter(Mandatory = $false)][switch] $IncludePackages ) $command = "sf project generate manifest" if ($PSBoundParameters.ContainsKey('TargetOrg') -and -not [string]::IsNullOrWhiteSpace($TargetOrg)) { $command += " --from-org $TargetOrg" } $command += " --name=allMetadata" $command += " --output-dir ." if ($IncludePackages) { $command += " --include-packages=unlocked" } $commonParams = Get-PsfdxCommonParameterSplat -BoundParameters $PSBoundParameters Invoke-Salesforce -Command $command @commonParams $command = "sf project retrieve start" if ($PSBoundParameters.ContainsKey('TargetOrg') -and -not [string]::IsNullOrWhiteSpace($TargetOrg)) { $command += " --target-org $TargetOrg" } $command += " --manifest allMetadata.xml" Invoke-Salesforce -Command $command @commonParams } #endregion #region Deploy function Deploy-SalesforceComponent { [CmdletBinding()] Param( [Parameter(Mandatory = $false)][ArgumentCompleter({ & (Get-Module psfdx-metadata -All | Select-Object -First 1) { Complete-SalesforceMetadataType @args } @args })][string] $Type, [Parameter(Mandatory = $false)][string] $Name, [Parameter(Mandatory = $false)][string] $SourceDir, [Parameter(Mandatory = $false)][switch] $IgnoreConflicts, [Parameter(Mandatory = $false)][switch] $IgnoreWarnings, [Parameter(Mandatory = $false)][switch] $IgnoreErrors, [Parameter(Mandatory = $false)][int] $Wait, [Parameter(Mandatory = $false)][ValidateSet( 'NoTests', 'SpecificTests', 'ReferencedTests', 'TestsInFolder', 'TestsInOrg', 'TestsInOrgAndPackages')][string] $TestLevel = 'NoTests', [Parameter(Mandatory = $false)][string[]] $Tests, [Parameter(Mandatory = $false)][switch] $DryRun, [Parameter(Mandatory = $false)][switch] $ConciseResults, [Parameter(Mandatory = $false)][switch] $DetailedResults, [Parameter(Mandatory = $false)][string] $TargetOrg ) if ($ConciseResults -and $DetailedResults) { throw "Specify only one of -ConciseResults or -DetailedResults." } if (-not $Type -and -not $SourceDir) { throw "Specify -Type or -SourceDir when deploying metadata." } if (-not $Type -and $Name) { throw "Specify -Type when using -Name." } if ($Type) { Assert-SalesforceMetadataType -Type $Type } $commonParams = Get-PsfdxCommonParameterSplat -BoundParameters $PSBoundParameters $command = "sf project deploy start" if ($Type) { $command += " --metadata $Type" if ($Name) { $command += ":$Name" } } if ($SourceDir) { if (-not (Test-Path -LiteralPath $SourceDir)) { throw "Source path '$SourceDir' does not exist." } $command += " --source-dir `"$SourceDir`"" } if ($PSBoundParameters.ContainsKey('TargetOrg') -and -not [string]::IsNullOrWhiteSpace($TargetOrg)) { $command += " --target-org $TargetOrg" } if ($IgnoreConflicts) { $command += " --ignore-conflicts" } if ($IgnoreWarnings) { $command += " --ignore-warnings" } if ($IgnoreErrors) { $command += " --ignore-errors" } if ($PSBoundParameters.ContainsKey('Wait')) { $command += " --wait $Wait" } $command += Get-SalesforceApexCliTestParams @commonParams -SourceDir $SourceDir -TestLevel $TestLevel -Tests $Tests if ($DryRun) { $command += " --dry-run" } if ($ConciseResults) { $command += " --concise" } if ($DetailedResults) { $command += " --verbose" } $command += " --json" $result = Invoke-Salesforce -Command $command @commonParams return Show-SalesforceResult -Result $result } function Deploy-SalesforceMetadata { [CmdletBinding()] Param( [Parameter(Mandatory = $false)][string] $Manifest, [Parameter(Mandatory = $false)][string] $InputDir, [Parameter(Mandatory = $false)][switch] $ManifestPackage, [Parameter(Mandatory = $false)][string] $TargetOrg, [Parameter(Mandatory = $false)][switch] $IgnoreConflicts, [Parameter(Mandatory = $false)][switch] $IgnoreWarnings, [Parameter(Mandatory = $false)][switch] $IgnoreErrors ) $optionsProvided = 0 if ($Manifest) { $optionsProvided++ } if ($InputDir) { $optionsProvided++ } if ($ManifestPackage) { $optionsProvided++ } if ($optionsProvided -ne 1) { throw "Specify exactly one of -Manifest, -InputDir, or -ManifestPackage." } if ($Manifest -and -not (Test-Path -Path $Manifest -PathType Leaf)) { throw "Manifest file '$Manifest' does not exist." } if ($InputDir -and -not (Test-Path -Path $InputDir -PathType Container)) { throw "Input directory '$InputDir' does not exist." } $command = "sf project deploy start" if ($Manifest) { $command += " --manifest `"$Manifest`"" } if ($InputDir) { $command += " --metadata-dir `"$InputDir`"" } if ($ManifestPackage) { $command += " --single-package" } if ($PSBoundParameters.ContainsKey('TargetOrg') -and -not [string]::IsNullOrWhiteSpace($TargetOrg)) { $command += " --target-org $TargetOrg" } if ($IgnoreConflicts) { $command += " --ignore-conflicts" } if ($IgnoreWarnings) { $command += " --ignore-warnings" } if ($IgnoreErrors) { $command += " --ignore-errors" } $command += " --json" $commonParams = Get-PsfdxCommonParameterSplat -BoundParameters $PSBoundParameters $result = Invoke-Salesforce -Command $command @commonParams return Show-SalesforceResult -Result $result } #endregion #region Deploy lifecycle function Get-SalesforceDeployJobParams { [CmdletBinding()] Param( [Parameter(Mandatory = $false)][string] $JobId, [Parameter(Mandatory = $false)][switch] $UseMostRecent ) if ($JobId -and $UseMostRecent) { throw "Specify only one of -JobId or -UseMostRecent." } if (-not $JobId -and -not $UseMostRecent) { throw "Specify -JobId or -UseMostRecent." } if ($JobId) { if ($JobId -notmatch '^0Af[a-zA-Z0-9]{12}([a-zA-Z0-9]{3})?$') { throw "Job ID '$JobId' is not a valid deploy job ID. Expected a 15 or 18 character ID starting with 0Af." } return " --job-id $JobId" } return " --use-most-recent" } function Test-SalesforceDeployWaitParams { [CmdletBinding()] Param( [Parameter(Mandatory = $false)][bool] $HasWait, [Parameter(Mandatory = $false)][bool] $Async ) if ($HasWait -and $Async) { throw "Specify only one of -Wait or -Async." } } function Test-SalesforceDeployResultOptions { [CmdletBinding()] Param( [Parameter(Mandatory = $false)][bool] $ConciseResults, [Parameter(Mandatory = $false)][bool] $DetailedResults ) if ($ConciseResults -and $DetailedResults) { throw "Specify only one of -ConciseResults or -DetailedResults." } } function Test-SalesforceValidDeployWait { [CmdletBinding()] Param( [Parameter(Mandatory = $true)][int] $Wait ) if ($Wait -lt 0) { throw "-Wait must be zero or greater (minutes)." } } function Test-SalesforceDeploy { [CmdletBinding()] Param( [Parameter(Mandatory = $false)][string] $Manifest, [Parameter(Mandatory = $false)][string] $SourceDir, [Parameter(Mandatory = $false)][string] $InputDir, [Parameter(Mandatory = $false)][switch] $ManifestPackage, [Parameter(Mandatory = $false)][ValidateSet( 'SpecificTests', 'ReferencedTests', 'TestsInFolder', 'TestsInOrg', 'TestsInOrgAndPackages', 'RelevantTests')][string] $TestLevel = 'TestsInOrg', [Parameter(Mandatory = $false)][string[]] $Tests, [Parameter(Mandatory = $false)][switch] $IgnoreWarnings, [Parameter(Mandatory = $false)][int] $Wait, [Parameter(Mandatory = $false)][switch] $Async, [Parameter(Mandatory = $false)][switch] $ConciseResults, [Parameter(Mandatory = $false)][switch] $DetailedResults, [Parameter(Mandatory = $false)][string] $TargetOrg ) $optionsProvided = 0 if ($Manifest) { $optionsProvided++ } if ($SourceDir) { $optionsProvided++ } if ($InputDir) { $optionsProvided++ } if ($optionsProvided -ne 1) { throw "Specify exactly one of -Manifest, -SourceDir, or -InputDir." } if ($ManifestPackage -and -not $InputDir) { throw "-ManifestPackage can only be used with -InputDir." } Test-SalesforceDeployResultOptions -ConciseResults ([bool]$ConciseResults) -DetailedResults ([bool]$DetailedResults) Test-SalesforceDeployWaitParams -HasWait ($PSBoundParameters.ContainsKey('Wait')) -Async ([bool]$Async) if ($PSBoundParameters.ContainsKey('Wait')) { Test-SalesforceValidDeployWait -Wait $Wait } if ($Manifest -and -not (Test-Path -LiteralPath $Manifest -PathType Leaf)) { throw "Manifest file '$Manifest' does not exist." } if ($SourceDir -and -not (Test-Path -LiteralPath $SourceDir)) { throw "Source path '$SourceDir' does not exist." } if ($InputDir) { if (-not (Test-Path -LiteralPath $InputDir)) { throw "Input path '$InputDir' does not exist." } if (-not (Test-Path -LiteralPath $InputDir -PathType Container)) { $inputExtension = [System.IO.Path]::GetExtension($InputDir) if (-not [string]::Equals($inputExtension, '.zip', [System.StringComparison]::OrdinalIgnoreCase)) { throw "Input path '$InputDir' must be a directory or a .zip file." } } } $commonParams = Get-PsfdxCommonParameterSplat -BoundParameters $PSBoundParameters $command = "sf project deploy validate" if ($Manifest) { $command += " --manifest `"$Manifest`"" } if ($SourceDir) { $command += " --source-dir `"$SourceDir`"" } if ($InputDir) { $command += " --metadata-dir `"$InputDir`"" } if ($ManifestPackage) { $command += " --single-package" } if ($PSBoundParameters.ContainsKey('TargetOrg') -and -not [string]::IsNullOrWhiteSpace($TargetOrg)) { $command += " --target-org $TargetOrg" } if ($IgnoreWarnings) { $command += " --ignore-warnings" } if ($PSBoundParameters.ContainsKey('Wait')) { $command += " --wait $Wait" } if ($Async) { $command += " --async" } $command += Get-SalesforceApexCliTestParams @commonParams -SourceDir $SourceDir -TestLevel $TestLevel -Tests $Tests if ($ConciseResults) { $command += " --concise" } if ($DetailedResults) { $command += " --verbose" } $command += " --json" $result = Invoke-Salesforce -Command $command @commonParams return Show-SalesforceResult -Result $result } function Start-SalesforceQuickDeploy { [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'High')] Param( [Parameter(Mandatory = $false)][string] $JobId, [Parameter(Mandatory = $false)][switch] $UseMostRecent, [Parameter(Mandatory = $false)][int] $Wait, [Parameter(Mandatory = $false)][switch] $Async, [Parameter(Mandatory = $false)][switch] $ConciseResults, [Parameter(Mandatory = $false)][switch] $DetailedResults, [Parameter(Mandatory = $false)][string] $TargetOrg ) $jobParams = Get-SalesforceDeployJobParams -JobId $JobId -UseMostRecent:$UseMostRecent Test-SalesforceDeployResultOptions -ConciseResults ([bool]$ConciseResults) -DetailedResults ([bool]$DetailedResults) Test-SalesforceDeployWaitParams -HasWait ($PSBoundParameters.ContainsKey('Wait')) -Async ([bool]$Async) if ($PSBoundParameters.ContainsKey('Wait')) { Test-SalesforceValidDeployWait -Wait $Wait } $command = "sf project deploy quick" + $jobParams if ($PSBoundParameters.ContainsKey('TargetOrg') -and -not [string]::IsNullOrWhiteSpace($TargetOrg)) { $command += " --target-org $TargetOrg" } if ($PSBoundParameters.ContainsKey('Wait')) { $command += " --wait $Wait" } if ($Async) { $command += " --async" } if ($ConciseResults) { $command += " --concise" } if ($DetailedResults) { $command += " --verbose" } $command += " --json" $commonParams = Get-PsfdxCommonParameterSplat -BoundParameters $PSBoundParameters $commonParams.Remove('WhatIf'); $commonParams.Remove('Confirm') $target = if ($JobId) { $JobId } else { 'most recent validated deployment' } if ($PSCmdlet.ShouldProcess($target, 'Quick deploy validated deployment')) { $result = Invoke-Salesforce -Command $command @commonParams return Show-SalesforceResult -Result $result } } function Get-SalesforceDeployStatus { [CmdletBinding()] Param( [Parameter(Mandatory = $false)][string] $JobId, [Parameter(Mandatory = $false)][switch] $UseMostRecent, [Parameter(Mandatory = $false)][int] $Wait, [Parameter(Mandatory = $false)][string] $TargetOrg ) $jobParams = Get-SalesforceDeployJobParams -JobId $JobId -UseMostRecent:$UseMostRecent if ($PSBoundParameters.ContainsKey('Wait')) { Test-SalesforceValidDeployWait -Wait $Wait } $command = "sf project deploy report" + $jobParams if ($PSBoundParameters.ContainsKey('TargetOrg') -and -not [string]::IsNullOrWhiteSpace($TargetOrg)) { $command += " --target-org $TargetOrg" } if ($PSBoundParameters.ContainsKey('Wait')) { $command += " --wait $Wait" } $command += " --json" $commonParams = Get-PsfdxCommonParameterSplat -BoundParameters $PSBoundParameters $result = Invoke-Salesforce -Command $command @commonParams return Show-SalesforceResult -Result $result } function Resume-SalesforceDeploy { [CmdletBinding()] Param( [Parameter(Mandatory = $false)][string] $JobId, [Parameter(Mandatory = $false)][switch] $UseMostRecent, [Parameter(Mandatory = $false)][int] $Wait, [Parameter(Mandatory = $false)][switch] $ConciseResults, [Parameter(Mandatory = $false)][switch] $DetailedResults ) $jobParams = Get-SalesforceDeployJobParams -JobId $JobId -UseMostRecent:$UseMostRecent Test-SalesforceDeployResultOptions -ConciseResults ([bool]$ConciseResults) -DetailedResults ([bool]$DetailedResults) if ($PSBoundParameters.ContainsKey('Wait')) { Test-SalesforceValidDeployWait -Wait $Wait } # sf project deploy resume has no --target-org; the org comes from the cached deployment. $command = "sf project deploy resume" + $jobParams if ($PSBoundParameters.ContainsKey('Wait')) { $command += " --wait $Wait" } if ($ConciseResults) { $command += " --concise" } if ($DetailedResults) { $command += " --verbose" } $command += " --json" $commonParams = Get-PsfdxCommonParameterSplat -BoundParameters $PSBoundParameters $result = Invoke-Salesforce -Command $command @commonParams return Show-SalesforceResult -Result $result } function Stop-SalesforceDeploy { [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'High')] Param( [Parameter(Mandatory = $false)][string] $JobId, [Parameter(Mandatory = $false)][switch] $UseMostRecent, [Parameter(Mandatory = $false)][int] $Wait, [Parameter(Mandatory = $false)][switch] $Async, [Parameter(Mandatory = $false)][string] $TargetOrg ) $jobParams = Get-SalesforceDeployJobParams -JobId $JobId -UseMostRecent:$UseMostRecent Test-SalesforceDeployWaitParams -HasWait ($PSBoundParameters.ContainsKey('Wait')) -Async ([bool]$Async) if ($PSBoundParameters.ContainsKey('Wait')) { Test-SalesforceValidDeployWait -Wait $Wait } $command = "sf project deploy cancel" + $jobParams if ($PSBoundParameters.ContainsKey('TargetOrg') -and -not [string]::IsNullOrWhiteSpace($TargetOrg)) { $command += " --target-org $TargetOrg" } if ($PSBoundParameters.ContainsKey('Wait')) { $command += " --wait $Wait" } if ($Async) { $command += " --async" } $command += " --json" $commonParams = Get-PsfdxCommonParameterSplat -BoundParameters $PSBoundParameters $commonParams.Remove('WhatIf'); $commonParams.Remove('Confirm') $target = if ($JobId) { $JobId } else { 'most recent deployment' } if ($PSCmdlet.ShouldProcess($target, 'Cancel deployment')) { $result = Invoke-Salesforce -Command $command @commonParams return Show-SalesforceResult -Result $result } } #endregion #region Describe function Describe-SalesforceObjects { [CmdletBinding()] Param( [Parameter(Mandatory = $false)][string] $TargetOrg ) $command = "sf sobject list" if ($PSBoundParameters.ContainsKey('TargetOrg') -and -not [string]::IsNullOrWhiteSpace($TargetOrg)) { $command += " --target-org $TargetOrg" } $command += " --json" $commonParams = Get-PsfdxCommonParameterSplat -BoundParameters $PSBoundParameters $result = Invoke-Salesforce -Command $command @commonParams return Show-SalesforceResult -Result $result } function Describe-SalesforceObject { [CmdletBinding()] Param( [Parameter(Mandatory = $true)][string] $Name, [Parameter(Mandatory = $false)][string] $TargetOrg, [Parameter(Mandatory = $false)][switch] $UseToolingApi ) $command = "sf sobject describe" if ($PSBoundParameters.ContainsKey('TargetOrg') -and -not [string]::IsNullOrWhiteSpace($TargetOrg)) { $command += " --target-org $TargetOrg" } $command += " --sobject $Name" if ($UseToolingApi) { $command += " --use-tooling-api" } $command += " --json" $commonParams = Get-PsfdxCommonParameterSplat -BoundParameters $PSBoundParameters $result = Invoke-Salesforce -Command $command @commonParams return Show-SalesforceResult -Result $result } function Describe-SalesforceFields { [CmdletBinding()] Param( [Parameter(Mandatory = $true)][string] $ObjectName, [Parameter(Mandatory = $false)][string] $TargetOrg, [Parameter(Mandatory = $false)][switch] $UseToolingApi ) $result = Describe-SalesforceObject -Name $ObjectName -TargetOrg $TargetOrg -UseToolingApi:$UseToolingApi $result = $result.fields $result = $result | Select-Object name, label, type, byteLength | Sort-Object name return $result } #endregion #region Types and Utilities function Describe-SalesforceMetadataTypes { [CmdletBinding()] Param([Parameter(Mandatory = $false)][string] $TargetOrg) $command = "sf org list metadata-types" if ($PSBoundParameters.ContainsKey('TargetOrg') -and -not [string]::IsNullOrWhiteSpace($TargetOrg)) { $command += " --target-org $TargetOrg" } $command += " --json" $commonParams = Get-PsfdxCommonParameterSplat -BoundParameters $PSBoundParameters $result = Invoke-Salesforce -Command $command @commonParams $result = $result | ConvertFrom-Json $metadataObjects = $result.result.metadataObjects if (-not $metadataObjects) { return @() } return $metadataObjects | ForEach-Object { $_.xmlName } | Where-Object { -not [string]::IsNullOrWhiteSpace($_) } } function Build-SalesforceQuery { [CmdletBinding()] Param( [Parameter(Mandatory = $true)][string] $ObjectName, [Parameter(Mandatory = $false)][string] $TargetOrg, [Parameter(Mandatory = $false)][switch] $UseToolingApi, [Parameter(Mandatory = $false)][switch] $ExcludeAuditFields, [Parameter(Mandatory = $false)][switch] $ExcludeNameFields, [Parameter(Mandatory = $false)][switch] $ExcludeContextFields ) $fields = Describe-SalesforceFields -ObjectName $ObjectName -TargetOrg $TargetOrg -UseToolingApi:$UseToolingApi if ($null -eq $fields) { return "" } $fieldNames = @() foreach ($field in $fields) { $fieldNames += $field.name } if ($ExcludeAuditFields) { $auditFields = @( 'CreatedById', 'CreatedDate', 'LastModifiedById', 'LastModifiedDate', 'SystemModstamp', 'IsDeleted' ) $fieldNames = $fieldNames | Where-Object { $auditFields -notcontains $_ } } if ($ExcludeNameFields) { $nameFields = @( 'Name', 'FirstName', 'LastName', 'Subject' ) $fieldNames = $fieldNames | Where-Object { $nameFields -notcontains $_ } } if ($ExcludeContextFields) { $contextFields = @( 'OwnerId', 'RecordTypeId', 'CurrencyIsoCode', 'Division' ) $fieldNames = $fieldNames | Where-Object { $contextFields -notcontains $_ } } $fieldNames = @($fieldNames) if ($fieldNames.Count -eq 0) { # Every field was excluded; 'SELECT FROM X' is not valid SOQL return "" } return "SELECT " + (@($fieldNames | ForEach-Object { ConvertTo-SalesforceSoqlIdentifier -Value $_ }) -join ",") + " FROM " + (ConvertTo-SalesforceSoqlIdentifier -Value $ObjectName) } #endregion |