From e8b9c52480439d64b3fdca8caeed06169f8977b9 Mon Sep 17 00:00:00 2001 From: svc-cli-bot Date: Sun, 24 Sep 2023 05:46:33 +0000 Subject: [PATCH] docs: publishing gh-pages [skip ci] --- classes/ComponentSet.html | 70 +++++++++---------- classes/ComponentSetBuilder.html | 4 +- classes/ConnectionResolver.html | 6 +- classes/DeployResult.html | 12 ++-- classes/ForceIgnore.html | 12 ++-- classes/LazyCollection.html | 16 ++--- classes/ManifestResolver.html | 6 +- classes/MetadataApiDeploy.html | 28 ++++---- classes/MetadataApiRetrieve.html | 28 ++++---- classes/MetadataConverter.html | 14 ++-- classes/MetadataResolver.html | 8 +-- classes/NodeFSTreeContainer.html | 16 ++--- classes/RegistryAccess.html | 20 +++--- classes/RetrieveResult.html | 10 +-- classes/SourceComponent.html | 48 ++++++------- classes/TreeContainer.html | 16 ++--- classes/VirtualTreeContainer.html | 20 +++--- classes/ZipTreeContainer.html | 18 ++--- classes/_internal_.DiagnosticUtil.html | 6 +- classes/_internal_.MetadataTransfer.html | 24 +++---- classes/_internal_.SourceAdapterFactory.html | 6 +- enums/ComponentStatus.html | 12 ++-- enums/DecompositionStrategy.html | 6 +- enums/DestructiveChangesType.html | 6 +- enums/RecompositionStrategy.html | 4 +- enums/RequestStatus.html | 16 ++--- enums/TransformerStrategy.html | 10 +-- enums/_internal_.ManageableState.html | 18 ++--- functions/getCurrentApiVersion.html | 2 +- interfaces/AsyncResult.html | 4 +- interfaces/CodeCoverage.html | 14 ++-- interfaces/CodeCoverageWarnings.html | 8 +-- interfaces/DeployVersionData.html | 8 +-- interfaces/Failures.html | 18 ++--- interfaces/FileResponseFailure.html | 18 ++--- interfaces/FileResponseSuccess.html | 10 +-- interfaces/FromManifestOptions.html | 16 ++--- interfaces/FromSourceOptions.html | 12 ++-- interfaces/LocationsNotCovered.html | 10 +-- interfaces/MetadataApiDeployOptions.html | 16 ++--- interfaces/MetadataApiDeployStatus.html | 54 +++++++------- interfaces/MetadataApiRetrieveStatus.html | 16 ++--- interfaces/MetadataComponent.html | 8 +-- interfaces/MetadataMember.html | 6 +- interfaces/MetadataRegistry.html | 10 +-- interfaces/MetadataRequestStatus.html | 10 +-- interfaces/MetadataTransformer.html | 8 +-- interfaces/MetadataType.html | 44 ++++++------ interfaces/OptionalTreeRegistryOptions.html | 6 +- interfaces/PackageManifestObject.html | 4 +- interfaces/PackageOption.html | 6 +- interfaces/PackageTypeMembers.html | 6 +- interfaces/RegistryOptions.html | 4 +- interfaces/RetrieveOptions.html | 18 ++--- interfaces/RetrieveVersionData.html | 6 +- interfaces/RunTestResult.html | 16 ++--- interfaces/ScopedPostDeploy.html | 6 +- interfaces/ScopedPostRetrieve.html | 6 +- interfaces/ScopedPreDeploy.html | 6 +- interfaces/ScopedPreRetrieve.html | 6 +- interfaces/SourceAdapter.html | 6 +- interfaces/Successes.html | 10 +-- interfaces/TreeOptions.html | 4 +- interfaces/_internal_.DirectoryIndex.html | 2 +- interfaces/_internal_.FileResponseBase.html | 8 +-- .../_internal_.FromConnectionOptions.html | 12 ++-- interfaces/_internal_.ListMetadataQuery.html | 6 +- .../_internal_.MetadataApiDeployOptions.html | 26 +++---- .../_internal_.MetadataTransferOptions.html | 10 +-- .../_internal_.MetadataTransferResult.html | 8 +-- .../_internal_.ResolveConnectionResult.html | 6 +- .../_internal_.ResolveManifestResult.html | 8 +-- interfaces/_internal_.SuffixIndex.html | 2 +- interfaces/_internal_.TypeIndex.html | 2 +- interfaces/_internal_.ZipEntry.html | 8 +-- types/ComponentDeployment.html | 2 +- types/ComponentDiagnostic.html | 2 +- types/ComponentLike.html | 2 +- types/ComponentRetrieval.html | 2 +- types/ComponentSetOptions.html | 2 +- types/ConvertOutputConfig.html | 2 +- types/ConvertResult.html | 2 +- types/DeployDetails.html | 2 +- types/DeployMessage.html | 2 +- types/DeploySetOptions.html | 2 +- types/DirectoryConfig.html | 2 +- types/FileProperties.html | 2 +- types/FileResponse.html | 2 +- types/MergeConfig.html | 2 +- types/MetadataApiRetrieveOptions.html | 2 +- types/MetadataXml.html | 2 +- types/PackageOptions.html | 2 +- types/RetrieveFailure.html | 2 +- types/RetrieveMessage.html | 2 +- types/RetrieveRequest.html | 2 +- types/RetrieveSetOptions.html | 2 +- types/RetrieveSuccess.html | 2 +- types/SfdxFileFormat.html | 2 +- types/SourcePath.html | 2 +- types/VirtualDirectory.html | 2 +- types/VirtualFile.html | 2 +- types/WriteInfo.html | 2 +- types/WriterFormat.html | 2 +- types/ZipConfig.html | 2 +- types/_internal_.BooleanString.html | 2 +- types/_internal_.ComponentProperties.html | 2 +- types/_internal_.ManifestOption.html | 2 +- types/_internal_.MarkedReplacement.html | 2 +- types/_internal_.MetadataOption.html | 2 +- types/_internal_.OrgOption.html | 2 +- types/_internal_.PackageName.html | 2 +- types/_internal_.UniqueOutputDir.html | 2 +- variables/registry.html | 2 +- 113 files changed, 518 insertions(+), 518 deletions(-) diff --git a/classes/ComponentSet.html b/classes/ComponentSet.html index 26a5ac13c3..957e1edc9f 100644 --- a/classes/ComponentSet.html +++ b/classes/ComponentSet.html @@ -29,7 +29,7 @@

Hierarchy

+
  • Defined in collections/componentSet.ts:56
    • @@ -94,7 +94,7 @@
    registry: Returns ComponentSet
    +
  • Defined in collections/componentSet.ts:87

    • Properties

    @@ -103,17 +103,17 @@

    Optional

    The metadata API version to use. E.g., 52.0

    +
  • Defined in collections/componentSet.ts:61

    • Optional forceIgnoredPaths

    forceIgnoredPaths?: Set<string>
    +
  • Defined in collections/componentSet.ts:73

    • Optional fullName

    fullName?: string
    +
  • Defined in collections/componentSet.ts:72

    • Optional projectDirectory

    projectDirectory?: string
    @@ -121,7 +121,7 @@

    Optional

    +
  • Defined in collections/componentSet.ts:71

    • Optional sourceApiVersion

    sourceApiVersion?: string
    @@ -129,12 +129,12 @@

    Optionalversion field in the manifest.

    +
  • Defined in collections/componentSet.ts:66

    • Static Readonly WILDCARD

    WILDCARD: "*" = '*'
    +
  • Defined in collections/componentSet.ts:57

    • Accessors

    @@ -144,7 +144,7 @@

    destructiveChangesPost

    Returns Map<string, Map<string, SourceComponent>>

    +
  • Defined in collections/componentSet.ts:119

    • destructiveChangesPre

    +
  • Defined in collections/componentSet.ts:115

    • size

    +
  • Defined in collections/componentSet.ts:106

    • Methods

    @@ -181,7 +181,7 @@

    [iterator]Returns Iterator<MetadataComponent, any, undefined>

    +
  • Defined in collections/componentSet.ts:612

    • add

    Returns void

    +
  • Defined in collections/componentSet.ts:485

    • deploy

    Returns Promise<MetadataApiDeploy>

    +
  • Defined in collections/componentSet.ts:305

    • filter

    +
  • Defined in collections/lazyCollection.ts:34

    • find

    +
  • Defined in collections/lazyCollection.ts:20

    • first

    +
  • Defined in collections/lazyCollection.ts:15

    • getComponentFilenamesByNameAndType

    +
  • Defined in collections/componentSet.ts:597

    • getDestructiveChangesType

    +
  • Defined in collections/componentSet.ts:646

    • getObject

    Returns Promise<PackageManifestObject>

    +
  • Defined in collections/componentSet.ts:370

    • getPackageXml

    Returns Promise<string>

    +
  • Defined in collections/componentSet.ts:451

    • getSourceComponents

    +
  • Defined in collections/componentSet.ts:470

    • getTypesOfDestructiveChanges

    +
  • Defined in collections/componentSet.ts:656

    • has

    Returns boolean

    +
  • Defined in collections/componentSet.ts:544

    • map

    +
  • Defined in collections/lazyCollection.ts:54

    • retrieve

    Returns Promise<MetadataApiRetrieve>

    +
  • Defined in collections/componentSet.ts:341

    • setDestructiveChangesType

    +
  • Defined in collections/componentSet.ts:636

    • toArray

    +
  • Defined in collections/lazyCollection.ts:68

    • Static fromConnection

    Returns Promise<ComponentSet>

    +
  • Defined in collections/componentSet.ts:264

  • Resolve components from an org connection.

    @@ -514,7 +514,7 @@

    Parameters

    options: FromConnectionOptions

    • Returns Promise<ComponentSet>

    +
  • Defined in collections/componentSet.ts:271

    • Static fromManifest

    Returns Promise<ComponentSet>

    +
  • Defined in collections/componentSet.ts:183

  • Resolve components from a manifest file in XML format. @@ -553,7 +553,7 @@

    Parameters

    options: FromManifestOptions

    • Returns Promise<ComponentSet>

    +
  • Defined in collections/componentSet.ts:196

    • Static fromSource

    Returns ComponentSet

    +
  • Defined in collections/componentSet.ts:129

  • Resolve metadata components from multiple file paths or directory paths in a file system.

    @@ -588,7 +588,7 @@
    fsPaths: stringReturns ComponentSet
    • +
  • Defined in collections/componentSet.ts:136

  • Resolve metadata components from file or directory paths in a file system. @@ -604,7 +604,7 @@

    Parameters

    options: FromSourceOptions

    • Returns ComponentSet

    +
  • Defined in collections/componentSet.ts:145
    • diff --git a/classes/ComponentSetBuilder.html b/classes/ComponentSetBuilder.html index a76b83fad4..6698c23e21 100644 --- a/classes/ComponentSetBuilder.html +++ b/classes/ComponentSetBuilder.html @@ -18,7 +18,7 @@

    Hierarchy

    • ComponentSetBuilder
    +
  • Defined in collections/componentSetBuilder.ts:46
    • @@ -59,7 +59,7 @@

    Parameters

    options: ComponentSetOptions

    Returns Promise<ComponentSet>

    +
  • Defined in collections/componentSetBuilder.ts:56
    • diff --git a/classes/ConnectionResolver.html b/classes/ConnectionResolver.html index f46a735d3f..240082b3e9 100644 --- a/classes/ConnectionResolver.html +++ b/classes/ConnectionResolver.html @@ -21,7 +21,7 @@

    Hierarchy

    • ConnectionResolver
    +
  • Defined in resolve/connectionResolver.ts:29
    • @@ -51,7 +51,7 @@
    connection: ConnectionRegistryAccess = ...

    Returns ConnectionResolver

    +
  • Defined in resolve/connectionResolver.ts:34

    • Methods

    @@ -77,7 +77,7 @@
    component: PartialReturns boolean

    Returns Promise<ResolveConnectionResult>

    +
  • Defined in resolve/connectionResolver.ts:40
    • diff --git a/classes/DeployResult.html b/classes/DeployResult.html index 7c86ec055e..8e86739122 100644 --- a/classes/DeployResult.html +++ b/classes/DeployResult.html @@ -22,7 +22,7 @@

    Implements

    +
  • Defined in client/metadataApiDeploy.ts:34
    • @@ -60,7 +60,7 @@
    Optional components: Map<string, string[]> = ...

    Returns DeployResult

    +
  • Defined in client/metadataApiDeploy.ts:39

    • Properties

    @@ -68,18 +68,18 @@

    Optionalcomponents?: ComponentSet

    +
  • Defined in client/metadataApiDeploy.ts:41

    • Readonly replacements

    replacements: Map<string, string[]> = ...
    +
  • Defined in client/metadataApiDeploy.ts:42

    • Readonly response

    response: MetadataApiDeployStatus
    +
  • Defined in client/metadataApiDeploy.ts:40

    • Methods

    @@ -90,7 +90,7 @@

    getFileResponsesReturns FileResponse[]

    +
  • Defined in client/metadataApiDeploy.ts:45
    • diff --git a/classes/ForceIgnore.html b/classes/ForceIgnore.html index 9e950380f3..3ccf40b184 100644 --- a/classes/ForceIgnore.html +++ b/classes/ForceIgnore.html @@ -18,7 +18,7 @@

    Hierarchy

    • ForceIgnore
    +
  • Defined in resolve/forceIgnore.ts:15
    • @@ -52,14 +52,14 @@

    Parameters

    forceIgnorePath: string = ''

    Returns ForceIgnore

    +
  • Defined in resolve/forceIgnore.ts:22

    • Properties

    Static Readonly FILE_NAME

    FILE_NAME: ".forceignore" = '.forceignore'
    +
  • Defined in resolve/forceIgnore.ts:16

    • Methods

    @@ -74,7 +74,7 @@

    Parameters

    fsPath: string

    Returns boolean

    +
  • Defined in resolve/forceIgnore.ts:72

    • denies

    Returns boolean

    +
  • Defined in resolve/forceIgnore.ts:63

    • Static findAndCreate

    Returns ForceIgnore

    +
  • Defined in resolve/forceIgnore.ts:54
    • diff --git a/classes/LazyCollection.html b/classes/LazyCollection.html index 2cf59eb7de..ede70b4f84 100644 --- a/classes/LazyCollection.html +++ b/classes/LazyCollection.html @@ -29,7 +29,7 @@

    Implements

    • Iterable<T>
    +
  • Defined in collections/lazyCollection.ts:8
    • @@ -67,7 +67,7 @@

    Parameters

    Optional iterable: Iterable<T>

    Returns LazyCollection<T>

    +
  • Defined in collections/lazyCollection.ts:11

    • Methods

    @@ -83,7 +83,7 @@

    [iterator]Returns Iterator<T, any, undefined>

    +
  • Defined in collections/lazyCollection.ts:87

    • filter

      @@ -107,7 +107,7 @@
      element: TReturns boolean

    Returns LazyCollection<T>

    +
  • Defined in collections/lazyCollection.ts:34

    • find

    Returns undefined | T

    +
  • Defined in collections/lazyCollection.ts:20

    • first

    +
  • Defined in collections/lazyCollection.ts:15

    • map

    Returns LazyCollection<R>

    +
  • Defined in collections/lazyCollection.ts:54

    • toArray

    +
  • Defined in collections/lazyCollection.ts:68
    • diff --git a/classes/ManifestResolver.html b/classes/ManifestResolver.html index d1edc3e688..006c88072e 100644 --- a/classes/ManifestResolver.html +++ b/classes/ManifestResolver.html @@ -21,7 +21,7 @@

    Hierarchy

    • ManifestResolver
    +
  • Defined in resolve/manifestResolver.ts:44
    • @@ -51,7 +51,7 @@
    tree: registry: RegistryAccess = ...

    Returns ManifestResolver

    +
  • Defined in resolve/manifestResolver.ts:48

    • Methods

    @@ -66,7 +66,7 @@

    Parameters

    manifestPath: string

    Returns Promise<ResolveManifestResult>

    +
  • Defined in resolve/manifestResolver.ts:53
    • diff --git a/classes/MetadataApiDeploy.html b/classes/MetadataApiDeploy.html index e5b8c024dc..697cbebee7 100644 --- a/classes/MetadataApiDeploy.html +++ b/classes/MetadataApiDeploy.html @@ -20,7 +20,7 @@

    Hierarchy

    • MetadataApiDeploy
    +
  • Defined in client/metadataApiDeploy.ts:220
    • @@ -65,14 +65,14 @@
    options: Returns MetadataApiDeploy
    +
  • Defined in client/metadataApiDeploy.ts:241

    • Properties

    Static Readonly DEFAULT_OPTIONS

    DEFAULT_OPTIONS: Partial<MetadataApiDeployOptions> = ...
    +
  • Defined in client/metadataApiDeploy.ts:225

    • Accessors

    @@ -83,7 +83,7 @@

    idReturns Options["id"]

    +
  • Defined in client/metadataTransfer.ts:58

    • Methods

    @@ -98,7 +98,7 @@

    cancelReturns Promise<void>

    +
  • Defined in client/metadataApiDeploy.ts:297

    • checkStatus

    +
  • Defined in client/metadataApiDeploy.ts:282

    • deployRecentValidation

    +
  • Defined in client/metadataApiDeploy.ts:264

    • onCancel

    +
  • Defined in client/metadataTransfer.ts:156

    • onError

    +
  • Defined in client/metadataTransfer.ts:160

    • onFinish

    +
  • Defined in client/metadataTransfer.ts:152

    • onUpdate

    +
  • Defined in client/metadataTransfer.ts:148

    • pollStatus

  • Poll for the status of the metadata transfer request. @@ -285,7 +285,7 @@

    Optional timeout: Returns Promise<DeployResult>
    • +
  • Defined in client/metadataTransfer.ts:93

    • start

    +
  • Defined in client/metadataTransfer.ts:67
    • diff --git a/classes/MetadataApiRetrieve.html b/classes/MetadataApiRetrieve.html index da480a1e72..82979814ce 100644 --- a/classes/MetadataApiRetrieve.html +++ b/classes/MetadataApiRetrieve.html @@ -20,7 +20,7 @@

    Hierarchy

    • MetadataApiRetrieve
    +
  • Defined in client/metadataApiRetrieve.ts:125
    • @@ -65,14 +65,14 @@
    options: Returns MetadataApiRetrieve
    +
  • Defined in client/metadataApiRetrieve.ts:134

    • Properties

    Static DEFAULT_OPTIONS

    DEFAULT_OPTIONS: Partial<MetadataApiRetrieveOptions> = ...
    +
  • Defined in client/metadataApiRetrieve.ts:130

    • Accessors

    @@ -83,7 +83,7 @@

    idReturns Options["id"]

    +
  • Defined in client/metadataTransfer.ts:58

    • Methods

    @@ -98,7 +98,7 @@

    cancelReturns Promise<void>

    +
  • Defined in client/metadataApiRetrieve.ts:172

    • checkStatus

    +
  • Defined in client/metadataApiRetrieve.ts:144

    • onCancel

    +
  • Defined in client/metadataTransfer.ts:156

    • onError

    +
  • Defined in client/metadataTransfer.ts:160

    • onFinish

    +
  • Defined in client/metadataTransfer.ts:152

    • onUpdate

    +
  • Defined in client/metadataTransfer.ts:148

    • pollStatus

  • Poll for the status of the metadata transfer request. @@ -256,7 +256,7 @@

    Optional timeout: Returns Promise<RetrieveResult>
    • +
  • Defined in client/metadataTransfer.ts:93

    • post

    +
  • Defined in client/metadataApiRetrieve.ts:176

    • start

    +
  • Defined in client/metadataTransfer.ts:67
    • diff --git a/classes/MetadataConverter.html b/classes/MetadataConverter.html index 262daa2ae6..4cf53363c5 100644 --- a/classes/MetadataConverter.html +++ b/classes/MetadataConverter.html @@ -18,7 +18,7 @@

    Hierarchy

    • MetadataConverter
    +
  • Defined in convert/metadataConverter.ts:24
    • @@ -53,29 +53,29 @@

    Parameters

    registry: RegistryAccess = ...

    Returns MetadataConverter

    +
  • Defined in convert/metadataConverter.ts:32

    • Properties

    Static Readonly DEFAULT_PACKAGE_PREFIX

    DEFAULT_PACKAGE_PREFIX: "metadataPackage" = 'metadataPackage'
    +
  • Defined in convert/metadataConverter.ts:28

    • Static Readonly DESTRUCTIVE_CHANGES_POST_XML_FILE

    DESTRUCTIVE_CHANGES_POST_XML_FILE: "destructiveChangesPost.xml" = 'destructiveChangesPost.xml'
    +
  • Defined in convert/metadataConverter.ts:26

    • Static Readonly DESTRUCTIVE_CHANGES_PRE_XML_FILE

    DESTRUCTIVE_CHANGES_PRE_XML_FILE: "destructiveChangesPre.xml" = 'destructiveChangesPre.xml'
    +
  • Defined in convert/metadataConverter.ts:27

    • Static Readonly PACKAGE_XML_FILE

    PACKAGE_XML_FILE: "package.xml" = 'package.xml'
    +
  • Defined in convert/metadataConverter.ts:25

    • Methods

    @@ -94,7 +94,7 @@
    targetFormat: ConvertOutputConfig

    Returns Promise<ConvertResult>

    +
  • Defined in convert/metadataConverter.ts:36
    • diff --git a/classes/MetadataResolver.html b/classes/MetadataResolver.html index bebad866d7..467b2aacbc 100644 --- a/classes/MetadataResolver.html +++ b/classes/MetadataResolver.html @@ -21,7 +21,7 @@

    Hierarchy

    • MetadataResolver
    +
  • Defined in resolve/metadataResolver.ts:26
    • @@ -61,14 +61,14 @@
    tree: useFsForceIgnore: boolean = true

    Returns MetadataResolver

    +
  • Defined in resolve/metadataResolver.ts:37

    • Properties

    forceIgnoredPaths

    forceIgnoredPaths: Set<string>
    +
  • Defined in resolve/metadataResolver.ts:27

    • Methods

    @@ -91,7 +91,7 @@
    Optional inclusiveFilter:

    Returns SourceComponent[]

    +
  • Defined in resolve/metadataResolver.ts:53
    • diff --git a/classes/NodeFSTreeContainer.html b/classes/NodeFSTreeContainer.html index 236891425c..0c6880fbdf 100644 --- a/classes/NodeFSTreeContainer.html +++ b/classes/NodeFSTreeContainer.html @@ -23,7 +23,7 @@

    Hierarchy

    • NodeFSTreeContainer
    +
  • Defined in resolve/treeContainers.ts:92
    • @@ -73,7 +73,7 @@
    fsPath: string

    Returns boolean

    +
  • Defined in resolve/treeContainers.ts:98

    • find

    +
  • Defined in resolve/treeContainers.ts:35

    • isDirectory

    +
  • Defined in resolve/treeContainers.ts:93

    • readDirectory

    +
  • Defined in resolve/treeContainers.ts:102

    • readFile

      @@ -159,7 +159,7 @@
      fsPath: string

    Returns Promise<Buffer>

    +
  • Defined in resolve/treeContainers.ts:106

    • readFileSync

      @@ -177,7 +177,7 @@
      fsPath: string

    Returns Buffer

    +
  • Defined in resolve/treeContainers.ts:111

    • stream

    +
  • Defined in resolve/treeContainers.ts:115
    • diff --git a/classes/RegistryAccess.html b/classes/RegistryAccess.html index 67df186dbd..c445115838 100644 --- a/classes/RegistryAccess.html +++ b/classes/RegistryAccess.html @@ -18,7 +18,7 @@

    Hierarchy

    • RegistryAccess
    +
  • Defined in registry/registryAccess.ts:19
    • @@ -53,7 +53,7 @@

    Parameters

    registry: MetadataRegistry = defaultRegistry

    Returns RegistryAccess

    +
  • Defined in registry/registryAccess.ts:26

    • Methods

    @@ -87,7 +87,7 @@
    type: Returns boolean

    Returns undefined | MetadataType

    +
  • Defined in registry/registryAccess.ts:111

    • getAliasTypes

    +
  • Defined in registry/registryAccess.ts:157

    • getFolderContentTypes

    +
  • Defined in registry/registryAccess.ts:140

    • getParentType

    Returns undefined | MetadataType

    +
  • Defined in registry/registryAccess.ts:170

    • getStrictFolderTypes

    +
  • Defined in registry/registryAccess.ts:123

    • getTypeByName

    Returns MetadataType

    +
  • Defined in registry/registryAccess.ts:36

    • getTypeBySuffix

    Returns undefined | MetadataType

    +
  • Defined in registry/registryAccess.ts:63

    • guessTypeBySuffix

    Returns undefined | {
        metadataTypeGuess: MetadataType;
        suffixGuess: string;
    }[]

    +
  • Defined in registry/registryAccess.ts:76
    • diff --git a/classes/RetrieveResult.html b/classes/RetrieveResult.html index cceb30b6f1..9e415c1ca3 100644 --- a/classes/RetrieveResult.html +++ b/classes/RetrieveResult.html @@ -22,7 +22,7 @@

    Implements

    +
  • Defined in client/metadataApiRetrieve.ts:37
    • @@ -65,7 +65,7 @@
    Optional localComponents:

    Returns RetrieveResult

    +
  • Defined in client/metadataApiRetrieve.ts:49

    • Properties

    @@ -73,13 +73,13 @@

    Readonlycomponents: ComponentSet

    +
  • Defined in client/metadataApiRetrieve.ts:51

    • Readonly response

    response: MetadataApiRetrieveStatus
    +
  • Defined in client/metadataApiRetrieve.ts:50

    • Methods

    @@ -90,7 +90,7 @@

    getFileResponsesReturns FileResponse[]

    +
  • Defined in client/metadataApiRetrieve.ts:57
    • diff --git a/classes/SourceComponent.html b/classes/SourceComponent.html index adaccb6514..f605a7e8ec 100644 --- a/classes/SourceComponent.html +++ b/classes/SourceComponent.html @@ -25,7 +25,7 @@

    Implements

    +
  • Defined in resolve/sourceComponent.ts:40
    • @@ -84,46 +84,46 @@
    tree: forceIgnore: ForceIgnore = ...

    Returns SourceComponent

    +
  • Defined in resolve/sourceComponent.ts:53

    • Properties

    Optional content

    content?: string
    +
  • Defined in resolve/sourceComponent.ts:46

    • Readonly name

    name: string
    +
  • Defined in resolve/sourceComponent.ts:41

    • Optional Readonly parent

    parent?: SourceComponent
    +
  • Defined in resolve/sourceComponent.ts:44

    • Optional parentType

    parentType?: MetadataType
    +
  • Defined in resolve/sourceComponent.ts:45

    • Optional replacements

    replacements?: Record<string, MarkedReplacement[]>
    +
  • Defined in resolve/sourceComponent.ts:47

    • Readonly type

    type: MetadataType
    +
  • Defined in resolve/sourceComponent.ts:42

    • Optional Readonly xml

    xml?: string
    +
  • Defined in resolve/sourceComponent.ts:43

    • Accessors

    @@ -134,7 +134,7 @@

    fullNameReturns string

    +
  • Defined in resolve/sourceComponent.ts:68

    • isAddressable

    +
  • Defined in resolve/sourceComponent.ts:115

    • metaFilePath

      @@ -166,7 +166,7 @@

      Returns

      The metafile path

    Returns undefined | string

    +
  • Defined in resolve/sourceComponent.ts:89

    • tree

    +
  • Defined in resolve/sourceComponent.ts:98

    • Methods

    @@ -191,7 +191,7 @@

    Returns

    SourceComponent[] containing valid children

    Returns SourceComponent[]

    +
  • Defined in resolve/sourceComponent.ts:163

    • getDestructiveChangesType

    +
  • Defined in resolve/sourceComponent.ts:251

    • getForceIgnore

    +
  • Defined in resolve/sourceComponent.ts:210

    • getPackageRelativePath

    Returns string

    +
  • Defined in resolve/sourceComponent.ts:238

    • isMarkedForDelete

    +
  • Defined in resolve/sourceComponent.ts:247

    • parseFromParentXml

    Returns T

    +
  • Defined in resolve/sourceComponent.ts:223

    • parseXml

    Returns Promise<T>

    +
  • Defined in resolve/sourceComponent.ts:183

    • parseXmlSync

    Returns T

    +
  • Defined in resolve/sourceComponent.ts:196

    • setMarkedForDelete

    Returns void

    +
  • Defined in resolve/sourceComponent.ts:255

    • walkContent

    +
  • Defined in resolve/sourceComponent.ts:143

    • Static createVirtualComponent

    Returns SourceComponent

    +
  • Defined in resolve/sourceComponent.ts:126
    • diff --git a/classes/TreeContainer.html b/classes/TreeContainer.html index 8a3f509934..0c29be05ee 100644 --- a/classes/TreeContainer.html +++ b/classes/TreeContainer.html @@ -27,7 +27,7 @@

    Hierarchy

  • VirtualTreeContainer
  • ZipTreeContainer
    • +
  • Defined in resolve/treeContainers.ts:26
    • @@ -75,7 +75,7 @@
    fsPath: string

    Returns boolean

    +
  • Defined in resolve/treeContainers.ts:51

    • find

    Returns undefined | string

    +
  • Defined in resolve/treeContainers.ts:35

    • Abstract isDirectory

    Returns boolean

    +
  • Defined in resolve/treeContainers.ts:58

    • Abstract readDirectory

    Returns string[]

    +
  • Defined in resolve/treeContainers.ts:65

    • Abstract readFile

    Returns Promise<Buffer>

    +
  • Defined in resolve/treeContainers.ts:72

    • Abstract readFileSync

    Returns Buffer

    +
  • Defined in resolve/treeContainers.ts:79

    • Abstract stream

    Returns Readable

    +
  • Defined in resolve/treeContainers.ts:86
    • diff --git a/classes/VirtualTreeContainer.html b/classes/VirtualTreeContainer.html index bbf45d7f3b..5f5fd085d0 100644 --- a/classes/VirtualTreeContainer.html +++ b/classes/VirtualTreeContainer.html @@ -23,7 +23,7 @@

    Hierarchy

    • VirtualTreeContainer
    +
  • Defined in resolve/treeContainers.ts:236
    • @@ -59,7 +59,7 @@
    virtualFs: Returns VirtualTreeContainer
    +
  • Defined in resolve/treeContainers.ts:240

    • Methods

    @@ -81,7 +81,7 @@
    fsPath: string

    Returns boolean

    +
  • Defined in resolve/treeContainers.ts:277

    • find

    +
  • Defined in resolve/treeContainers.ts:35

    • isDirectory

    +
  • Defined in resolve/treeContainers.ts:270

    • readDirectory

    +
  • Defined in resolve/treeContainers.ts:283

    • readFile

      @@ -167,7 +167,7 @@
      fsPath: string

    Returns Promise<Buffer>

    +
  • Defined in resolve/treeContainers.ts:290

    • readFileSync

      @@ -185,7 +185,7 @@
      fsPath: string

    Returns Buffer

    +
  • Defined in resolve/treeContainers.ts:294

    • stream

    +
  • Defined in resolve/treeContainers.ts:307

    • Static fromFilePaths

    +
  • Defined in resolve/treeContainers.ts:252
    • diff --git a/classes/ZipTreeContainer.html b/classes/ZipTreeContainer.html index a6aabfa45c..7a005cd4ca 100644 --- a/classes/ZipTreeContainer.html +++ b/classes/ZipTreeContainer.html @@ -24,7 +24,7 @@

    Hierarchy

    • ZipTreeContainer
    +
  • Defined in resolve/treeContainers.ts:133
    • @@ -62,7 +62,7 @@
    fsPath: string

    Returns boolean

    +
  • Defined in resolve/treeContainers.ts:152

    • find

    +
  • Defined in resolve/treeContainers.ts:35

    • isDirectory

    +
  • Defined in resolve/treeContainers.ts:156

    • readDirectory

    +
  • Defined in resolve/treeContainers.ts:163

    • readFile

      @@ -148,7 +148,7 @@
      fsPath: string

    Returns Promise<Buffer>

    +
  • Defined in resolve/treeContainers.ts:170

    • readFileSync

      @@ -166,7 +166,7 @@
      fsPath: string

    Returns Buffer

    +
  • Defined in resolve/treeContainers.ts:188

    • stream

    +
  • Defined in resolve/treeContainers.ts:192

    • Static create

    Returns Promise<ZipTreeContainer>

    +
  • Defined in resolve/treeContainers.ts:147
    • diff --git a/classes/_internal_.DiagnosticUtil.html b/classes/_internal_.DiagnosticUtil.html index 53f2b07ea9..035a845947 100644 --- a/classes/_internal_.DiagnosticUtil.html +++ b/classes/_internal_.DiagnosticUtil.html @@ -19,7 +19,7 @@

    Hierarchy

    • DiagnosticUtil
    +
  • Defined in client/diagnosticUtil.ts:14
    • @@ -47,7 +47,7 @@

    Parameters

    api: "metadata" | "tooling"

    Returns DiagnosticUtil

    +
  • Defined in client/diagnosticUtil.ts:17

    • Methods

    @@ -64,7 +64,7 @@
    component: message: string | DeployMessage

    Returns ComponentDiagnostic

    +
  • Defined in client/diagnosticUtil.ts:21
    • diff --git a/classes/_internal_.MetadataTransfer.html b/classes/_internal_.MetadataTransfer.html index eb36a2666f..9bdfe7eb98 100644 --- a/classes/_internal_.MetadataTransfer.html +++ b/classes/_internal_.MetadataTransfer.html @@ -31,7 +31,7 @@

    Hierarchy

  • MetadataApiDeploy
  • MetadataApiRetrieve
    • +
  • Defined in client/metadataTransfer.ts:36
    • @@ -79,7 +79,7 @@

    Parameters

    __namedParameters: Options

    Returns MetadataTransfer<Status, Result, Options>

    +
  • Defined in client/metadataTransfer.ts:49

    • Accessors

    @@ -89,7 +89,7 @@

    id

    Returns Options["id"]

    +
  • Defined in client/metadataTransfer.ts:58

    • Methods

    @@ -99,7 +99,7 @@

    Abstract

    Returns Promise<void>

    +
  • Defined in client/metadataTransfer.ts:284

    • Abstract checkStatus

    +
  • Defined in client/metadataTransfer.ts:283

    • onCancel

      @@ -131,7 +131,7 @@
      result: undefinedReturns void

    Returns void

    +
  • Defined in client/metadataTransfer.ts:156

    • onError

    Returns void

    Returns void

    +
  • Defined in client/metadataTransfer.ts:160

    • onFinish

    Returns void

    +
  • Defined in client/metadataTransfer.ts:152

    • onUpdate

    Returns void

    +
  • Defined in client/metadataTransfer.ts:148

    • pollStatus

  • Poll for the status of the metadata transfer request. @@ -246,7 +246,7 @@

    Optional timeout: Returns Promise<Result>
    • +
  • Defined in client/metadataTransfer.ts:93

    • start

    +
  • Defined in client/metadataTransfer.ts:67
    • diff --git a/classes/_internal_.SourceAdapterFactory.html b/classes/_internal_.SourceAdapterFactory.html index f390a28a2b..21aa7cf2da 100644 --- a/classes/_internal_.SourceAdapterFactory.html +++ b/classes/_internal_.SourceAdapterFactory.html @@ -19,7 +19,7 @@

    Hierarchy

    • SourceAdapterFactory
    +
  • Defined in resolve/adapters/sourceAdapterFactory.ts:31
    • @@ -49,7 +49,7 @@
    registry: tree: TreeContainer

    Returns SourceAdapterFactory

    +
  • Defined in resolve/adapters/sourceAdapterFactory.ts:35

    • Methods

    @@ -66,7 +66,7 @@
    type: forceIgnore: ForceIgnore = ...

    Returns SourceAdapter

    +
  • Defined in resolve/adapters/sourceAdapterFactory.ts:40
    • diff --git a/enums/ComponentStatus.html b/enums/ComponentStatus.html index e6046a7033..e84153803e 100644 --- a/enums/ComponentStatus.html +++ b/enums/ComponentStatus.html @@ -14,7 +14,7 @@
  • ComponentStatus

    • Enumeration ComponentStatus

    +
  • Defined in client/types.ts:19
    • @@ -34,27 +34,27 @@

    Enumeration Members

    Changed

    Changed: "Changed"
    +
  • Defined in client/types.ts:21

    • Created

    Created: "Created"
    +
  • Defined in client/types.ts:20

    • Deleted

    Deleted: "Deleted"
    +
  • Defined in client/types.ts:23

    • Failed

    Failed: "Failed"
    +
  • Defined in client/types.ts:24

    • Unchanged

    Unchanged: "Unchanged"
    +
  • Defined in client/types.ts:22
    • diff --git a/enums/DecompositionStrategy.html b/enums/DecompositionStrategy.html index 20cb178ff1..5d4afb1e30 100644 --- a/enums/DecompositionStrategy.html +++ b/enums/DecompositionStrategy.html @@ -17,7 +17,7 @@

    Enumeration DecompositionStrategyConst

    Strategy names for handling component decomposition.

    +
  • Defined in registry/types.ts:180
    • @@ -36,14 +36,14 @@

    FolderPerType

    Elements of child types are decomposed into folders of their respective types.

    +
  • Defined in registry/types.ts:188

    • TopLevel

    TopLevel: "topLevel"

    Elements of child types are decomposed to the same folder the parent object is in.

    +
  • Defined in registry/types.ts:184
    • diff --git a/enums/DestructiveChangesType.html b/enums/DestructiveChangesType.html index 130e457a16..f0ac7ba733 100644 --- a/enums/DestructiveChangesType.html +++ b/enums/DestructiveChangesType.html @@ -14,7 +14,7 @@
  • DestructiveChangesType

    • Enumeration DestructiveChangesType

    +
  • Defined in collections/types.ts:26
    • @@ -31,12 +31,12 @@

    Enumeration Members

    POST

    POST: "post"
    +
  • Defined in collections/types.ts:27

    • PRE

    PRE: "pre"
    +
  • Defined in collections/types.ts:28
    • diff --git a/enums/RecompositionStrategy.html b/enums/RecompositionStrategy.html index cefdff4c71..3df1f70d32 100644 --- a/enums/RecompositionStrategy.html +++ b/enums/RecompositionStrategy.html @@ -17,7 +17,7 @@

    Enumeration RecompositionStrategyConst

    Strategy names for handling component recomposition.

    +
  • Defined in registry/types.ts:194
    • @@ -35,7 +35,7 @@

    StartEmpty

    The parent object should start as an empty object when recomposing the child types

    +
  • Defined in registry/types.ts:198
    • diff --git a/enums/RequestStatus.html b/enums/RequestStatus.html index 1f35b592b5..146ce34953 100644 --- a/enums/RequestStatus.html +++ b/enums/RequestStatus.html @@ -14,7 +14,7 @@
  • RequestStatus

    • Enumeration RequestStatus

    +
  • Defined in client/types.ts:77
    • @@ -36,37 +36,37 @@

    Enumeration Members

    Canceled

    Canceled: "Canceled"
    +
  • Defined in client/types.ts:84

    • Canceling

    Canceling: "Canceling"
    +
  • Defined in client/types.ts:83

    • Failed

    Failed: "Failed"
    +
  • Defined in client/types.ts:82

    • InProgress

    InProgress: "InProgress"
    +
  • Defined in client/types.ts:79

    • Pending

    Pending: "Pending"
    +
  • Defined in client/types.ts:78

    • Succeeded

    Succeeded: "Succeeded"
    +
  • Defined in client/types.ts:80

    • SucceededPartial

    SucceededPartial: "SucceededPartial"
    +
  • Defined in client/types.ts:81
    • diff --git a/enums/TransformerStrategy.html b/enums/TransformerStrategy.html index 6d23d5220d..704591ab5e 100644 --- a/enums/TransformerStrategy.html +++ b/enums/TransformerStrategy.html @@ -17,7 +17,7 @@

    Enumeration TransformerStrategyConst

    Strategy names for the type of transformation to use for metadata types.

    +
  • Defined in registry/types.ts:204
    • @@ -36,22 +36,22 @@

    Enumeration Members

    Decomposed

    Decomposed: "decomposed"
    +
  • Defined in registry/types.ts:206

    • NonDecomposed

    NonDecomposed: "nonDecomposed"
    +
  • Defined in registry/types.ts:208

    • Standard

    Standard: "standard"
    +
  • Defined in registry/types.ts:205

    • StaticResource

    StaticResource: "staticResource"
    +
  • Defined in registry/types.ts:207
    • diff --git a/enums/_internal_.ManageableState.html b/enums/_internal_.ManageableState.html index ea9f77ef22..8d1b909a7f 100644 --- a/enums/_internal_.ManageableState.html +++ b/enums/_internal_.ManageableState.html @@ -15,7 +15,7 @@
  • ManageableState

    • Enumeration ManageableState

    +
  • Defined in client/types.ts:224
    • @@ -38,42 +38,42 @@

    Enumeration Members

    Beta

    Beta: "beta"
    +
  • Defined in client/types.ts:225

    • Deleted

    Deleted: "deleted"
    +
  • Defined in client/types.ts:226

    • Deprecated

    Deprecated: "deprecated"
    +
  • Defined in client/types.ts:227

    • DeprecatedEditable

    DeprecatedEditable: "deprecatedEditable"
    +
  • Defined in client/types.ts:228

    • Installed

    Installed: "installed"
    +
  • Defined in client/types.ts:229

    • InstalledEditable

    InstalledEditable: "installedEditable"
    +
  • Defined in client/types.ts:230

    • Released

    Released: "released"
    +
  • Defined in client/types.ts:231

    • Unmanaged

    Unmanaged: "unmanaged"
    +
  • Defined in client/types.ts:232
    • diff --git a/functions/getCurrentApiVersion.html b/functions/getCurrentApiVersion.html index cfdfe8526e..f5d063eeb1 100644 --- a/functions/getCurrentApiVersion.html +++ b/functions/getCurrentApiVersion.html @@ -19,7 +19,7 @@

    Function getCurrentApiVersion

  • Returns Promise<number>

    • +
  • Defined in registry/coverage.ts:24
    • diff --git a/interfaces/AsyncResult.html b/interfaces/AsyncResult.html index 0d1a7e0539..ddcaffcbb4 100644 --- a/interfaces/AsyncResult.html +++ b/interfaces/AsyncResult.html @@ -18,7 +18,7 @@

    Hierarchy

    • AsyncResult
    +
  • Defined in client/types.ts:73
    • @@ -34,7 +34,7 @@

    Properties

    id

    id: string
    +
  • Defined in client/types.ts:74
    • diff --git a/interfaces/CodeCoverage.html b/interfaces/CodeCoverage.html index 81a540cf25..251dc3e354 100644 --- a/interfaces/CodeCoverage.html +++ b/interfaces/CodeCoverage.html @@ -18,7 +18,7 @@

    Hierarchy

    • CodeCoverage
    +
  • Defined in client/types.ts:154
    • @@ -39,32 +39,32 @@

    Properties

    id

    id: string
    +
  • Defined in client/types.ts:155

    • Optional locationsNotCovered

    locationsNotCovered?: LocationsNotCovered | LocationsNotCovered[]
    +
  • Defined in client/types.ts:156

    • name

    name: string
    +
  • Defined in client/types.ts:157

    • numLocations

    numLocations: string
    +
  • Defined in client/types.ts:158

    • numLocationsNotCovered

    numLocationsNotCovered: string
    +
  • Defined in client/types.ts:159

    • type

    type: string
    +
  • Defined in client/types.ts:160
    • diff --git a/interfaces/CodeCoverageWarnings.html b/interfaces/CodeCoverageWarnings.html index db6640f294..958cc62bca 100644 --- a/interfaces/CodeCoverageWarnings.html +++ b/interfaces/CodeCoverageWarnings.html @@ -18,7 +18,7 @@

    Hierarchy

    • CodeCoverageWarnings
    +
  • Defined in client/types.ts:170
    • @@ -36,17 +36,17 @@

    Properties

    id

    id: string
    +
  • Defined in client/types.ts:171

    • message

    message: string
    +
  • Defined in client/types.ts:172

    • namespace

    namespace: string
    +
  • Defined in client/types.ts:173
    • diff --git a/interfaces/DeployVersionData.html b/interfaces/DeployVersionData.html index 56a682f788..490d165017 100644 --- a/interfaces/DeployVersionData.html +++ b/interfaces/DeployVersionData.html @@ -18,7 +18,7 @@

    Hierarchy

    • DeployVersionData
    +
  • Defined in client/types.ts:364
    • @@ -36,17 +36,17 @@

    Properties

    apiVersion

    apiVersion: string
    +
  • Defined in client/types.ts:365

    • manifestVersion

    manifestVersion: undefined | string
    +
  • Defined in client/types.ts:366

    • webService

    webService: "SOAP" | "REST"
    +
  • Defined in client/types.ts:367
    • diff --git a/interfaces/Failures.html b/interfaces/Failures.html index ce1f824f85..28710faaaa 100644 --- a/interfaces/Failures.html +++ b/interfaces/Failures.html @@ -18,7 +18,7 @@

    Hierarchy

    • Failures
    +
  • Defined in client/types.ts:176
    • @@ -41,42 +41,42 @@

    Properties

    id

    id: string
    +
  • Defined in client/types.ts:177

    • message

    message: string
    +
  • Defined in client/types.ts:178

    • methodName

    methodName: string
    +
  • Defined in client/types.ts:179

    • name

    name: string
    +
  • Defined in client/types.ts:180

    • packageName

    packageName: string
    +
  • Defined in client/types.ts:181

    • stackTrace

    stackTrace: string
    +
  • Defined in client/types.ts:182

    • time

    time: string
    +
  • Defined in client/types.ts:183

    • type

    type: string
    +
  • Defined in client/types.ts:184
    • diff --git a/interfaces/FileResponseFailure.html b/interfaces/FileResponseFailure.html index e75a2f4751..84e4e68c81 100644 --- a/interfaces/FileResponseFailure.html +++ b/interfaces/FileResponseFailure.html @@ -20,7 +20,7 @@

    Hierarchy

    • FileResponseFailure
    +
  • Defined in client/types.ts:58
    • @@ -43,45 +43,45 @@

    Properties

    Optional columnNumber

    columnNumber?: number
    +
  • Defined in client/types.ts:61

    • error

    error: string
    +
  • Defined in client/types.ts:62

    • Optional filePath

    filePath?: string
    +
  • Defined in client/types.ts:51

    • fullName

    fullName: string
    +
  • Defined in client/types.ts:49

    • Optional lineNumber

    lineNumber?: number
    +
  • Defined in client/types.ts:60

    • problemType

    problemType: "Warning" | "Error"
    +
  • Defined in client/types.ts:63

    • state

    state: Failed
    +
  • Defined in client/types.ts:59

    • type

    type: string
    +
  • Defined in client/types.ts:50
    • diff --git a/interfaces/FileResponseSuccess.html b/interfaces/FileResponseSuccess.html index 6cc0bb6539..d1e81736f4 100644 --- a/interfaces/FileResponseSuccess.html +++ b/interfaces/FileResponseSuccess.html @@ -20,7 +20,7 @@

    Hierarchy

    • FileResponseSuccess
    +
  • Defined in client/types.ts:54
    • @@ -40,24 +40,24 @@

    OptionalfilePath?: string

    +
  • Defined in client/types.ts:51

    • fullName

    fullName: string
    +
  • Defined in client/types.ts:49

    • state

    state: Created | Changed | Unchanged | Deleted
    +
  • Defined in client/types.ts:55

    • type

    type: string
    +
  • Defined in client/types.ts:50
    • diff --git a/interfaces/FromManifestOptions.html b/interfaces/FromManifestOptions.html index 69c7e0c84b..6df6ab1fbe 100644 --- a/interfaces/FromManifestOptions.html +++ b/interfaces/FromManifestOptions.html @@ -20,7 +20,7 @@

    Hierarchy

    • FromManifestOptions
    +
  • Defined in collections/types.ts:46
    • @@ -44,14 +44,14 @@

    Optional

    path to a destructiveChangesPost.xml file in XML format

    +
  • Defined in collections/types.ts:75

    • Optional destructivePre

    destructivePre?: string

    path to a destructiveChangesPre.xml file in XML format

    +
  • Defined in collections/types.ts:71

    • Optional forceAddWildcards

    forceAddWildcards?: boolean
    @@ -64,20 +64,20 @@

    Optional

    +
  • Defined in collections/types.ts:66

    • manifestPath

    manifestPath: string

    Path to the manifest file in XML format

    +
  • Defined in collections/types.ts:50

    • Optional registry

    registry?: RegistryAccess
    +
  • Defined in common/types.ts:21

    • Optional resolveSourcePaths

    resolveSourcePaths?: string[]
    @@ -85,13 +85,13 @@

    Optional

    +
  • Defined in collections/types.ts:55

    • Optional tree

    tree?: TreeContainer
    +
  • Defined in common/types.ts:17
    • diff --git a/interfaces/FromSourceOptions.html b/interfaces/FromSourceOptions.html index 732e3bf439..cba24d9d2d 100644 --- a/interfaces/FromSourceOptions.html +++ b/interfaces/FromSourceOptions.html @@ -20,7 +20,7 @@

    Hierarchy

    • FromSourceOptions
    +
  • Defined in collections/types.ts:31
    • @@ -42,33 +42,33 @@

    Optional

    File paths or directory paths of deleted components, i.e., destructive changes.

    +
  • Defined in collections/types.ts:43

    • fsPaths

    fsPaths: string[]

    File paths or directory paths to resolve components against

    +
  • Defined in collections/types.ts:35

    • Optional include

    include?: ComponentSet

    Only resolve components contained in the given set

    +
  • Defined in collections/types.ts:39

    • Optional registry

    registry?: RegistryAccess
    +
  • Defined in common/types.ts:21

    • Optional tree

    tree?: TreeContainer
    +
  • Defined in common/types.ts:17
    • diff --git a/interfaces/LocationsNotCovered.html b/interfaces/LocationsNotCovered.html index 5355bfee09..33169159de 100644 --- a/interfaces/LocationsNotCovered.html +++ b/interfaces/LocationsNotCovered.html @@ -18,7 +18,7 @@

    Hierarchy

    • LocationsNotCovered
    +
  • Defined in client/types.ts:163
    • @@ -37,22 +37,22 @@

    Properties

    column

    column: string
    +
  • Defined in client/types.ts:164

    • line

    line: string
    +
  • Defined in client/types.ts:165

    • numExecutions

    numExecutions: string
    +
  • Defined in client/types.ts:166

    • time

    time: string
    +
  • Defined in client/types.ts:167
    • diff --git a/interfaces/MetadataApiDeployOptions.html b/interfaces/MetadataApiDeployOptions.html index c844e618ee..afda573448 100644 --- a/interfaces/MetadataApiDeployOptions.html +++ b/interfaces/MetadataApiDeployOptions.html @@ -20,7 +20,7 @@

    Hierarchy

    • MetadataApiDeployOptions
    +
  • Defined in client/metadataApiDeploy.ts:208
    • @@ -42,45 +42,45 @@

    Properties

    Optional apiOptions

    apiOptions?: <internal>.MetadataApiDeployOptions
    +
  • Defined in client/metadataApiDeploy.ts:209

    • Optional apiVersion

    apiVersion?: string
    +
  • Defined in client/metadataTransfer.ts:32

    • Optional components

    components?: ComponentSet
    +
  • Defined in client/metadataTransfer.ts:31

    • Optional id

    id?: string
    +
  • Defined in client/metadataTransfer.ts:33

    • Optional mdapiPath

    mdapiPath?: string

    Path to a directory containing mdapi-formatted code and a package.xml

    +
  • Defined in client/metadataApiDeploy.ts:217

    • usernameOrConnection

    usernameOrConnection: string | Connection<Schema>
    +
  • Defined in client/metadataTransfer.ts:30

    • Optional zipPath

    zipPath?: string

    Path to a zip file containing mdapi-formatted code and a package.xml

    +
  • Defined in client/metadataApiDeploy.ts:213
    • diff --git a/interfaces/MetadataApiDeployStatus.html b/interfaces/MetadataApiDeployStatus.html index d657c93040..070c11b750 100644 --- a/interfaces/MetadataApiDeployStatus.html +++ b/interfaces/MetadataApiDeployStatus.html @@ -23,7 +23,7 @@

    Hierarchy

    • MetadataApiDeployStatus
    +
  • Defined in client/types.ts:111
    • @@ -64,136 +64,136 @@

    Properties

    Optional canceledBy

    canceledBy?: string
    +
  • Defined in client/types.ts:112

    • Optional canceledByName

    canceledByName?: string
    +
  • Defined in client/types.ts:113

    • checkOnly

    checkOnly: boolean
    +
  • Defined in client/types.ts:114

    • Optional completedDate

    completedDate?: string
    +
  • Defined in client/types.ts:115

    • createdBy

    createdBy: string
    +
  • Defined in client/types.ts:116

    • createdByName

    createdByName: string
    +
  • Defined in client/types.ts:117

    • createdDate

    createdDate: string
    +
  • Defined in client/types.ts:118

    • details

    details: DeployDetails
    +
  • Defined in client/types.ts:119

    • done

    done: boolean
    +
  • Defined in client/types.ts:91

    • Optional errorMessage

    errorMessage?: string
    +
  • Defined in client/types.ts:120

    • Optional errorStatusCode

    errorStatusCode?: string
    +
  • Defined in client/types.ts:121

    • id

    id: string
    +
  • Defined in client/types.ts:88

    • ignoreWarnings

    ignoreWarnings: boolean
    +
  • Defined in client/types.ts:122

    • lastModifiedDate

    lastModifiedDate: string
    +
  • Defined in client/types.ts:123

    • numberComponentErrors

    numberComponentErrors: number
    +
  • Defined in client/types.ts:124

    • numberComponentsDeployed

    numberComponentsDeployed: number
    +
  • Defined in client/types.ts:125

    • numberComponentsTotal

    numberComponentsTotal: number
    +
  • Defined in client/types.ts:126

    • numberTestErrors

    numberTestErrors: number
    +
  • Defined in client/types.ts:127

    • numberTestsCompleted

    numberTestsCompleted: number
    +
  • Defined in client/types.ts:128

    • numberTestsTotal

    numberTestsTotal: number
    +
  • Defined in client/types.ts:129

    • rollbackOnError

    rollbackOnError: boolean
    +
  • Defined in client/types.ts:131

    • runTestsEnabled

    runTestsEnabled: boolean
    +
  • Defined in client/types.ts:130

    • Optional startDate

    startDate?: string
    +
  • Defined in client/types.ts:132

    • Optional stateDetail

    stateDetail?: string
    +
  • Defined in client/types.ts:133

    • status

    status: RequestStatus
    +
  • Defined in client/types.ts:89

    • success

    success: boolean
    +
  • Defined in client/types.ts:90
    • diff --git a/interfaces/MetadataApiRetrieveStatus.html b/interfaces/MetadataApiRetrieveStatus.html index 2b70cc46b7..1e82949239 100644 --- a/interfaces/MetadataApiRetrieveStatus.html +++ b/interfaces/MetadataApiRetrieveStatus.html @@ -21,7 +21,7 @@

    Hierarchy

    • MetadataApiRetrieveStatus
    +
  • Defined in client/types.ts:253
    • @@ -43,39 +43,39 @@

    Properties

    done

    done: boolean
    +
  • Defined in client/types.ts:254

    • fileProperties

    fileProperties: FileProperties | FileProperties[]
    +
  • Defined in client/types.ts:255

    • id

    id: string
    +
  • Defined in client/types.ts:256

    • Optional messages

    messages?: RetrieveMessage | RetrieveMessage[]
    +
  • Defined in client/types.ts:259

    • status

    status: RequestStatus
    +
  • Defined in client/types.ts:257

    • success

    success: boolean
    +
  • Defined in client/types.ts:258

    • zipFile

    zipFile: string

    base64 encoded string

    +
  • Defined in client/types.ts:261
    • diff --git a/interfaces/MetadataComponent.html b/interfaces/MetadataComponent.html index befc9a9b0c..9ea85d2591 100644 --- a/interfaces/MetadataComponent.html +++ b/interfaces/MetadataComponent.html @@ -22,7 +22,7 @@

    Implemented by

    +
  • Defined in resolve/types.ts:12
    • @@ -40,17 +40,17 @@

    Properties

    fullName

    fullName: string
    +
  • Defined in resolve/types.ts:13

    • Optional parent

    parent?: MetadataComponent
    +
  • Defined in resolve/types.ts:15

    • type

    type: MetadataType
    +
  • Defined in resolve/types.ts:14
    • diff --git a/interfaces/MetadataMember.html b/interfaces/MetadataMember.html index 4c4edc696d..aeb914f236 100644 --- a/interfaces/MetadataMember.html +++ b/interfaces/MetadataMember.html @@ -18,7 +18,7 @@

    Hierarchy

    • MetadataMember
    +
  • Defined in resolve/types.ts:18
    • @@ -35,12 +35,12 @@

    Properties

    fullName

    fullName: string
    +
  • Defined in resolve/types.ts:19

    • type

    type: string
    +
  • Defined in resolve/types.ts:20
    • diff --git a/interfaces/MetadataRegistry.html b/interfaces/MetadataRegistry.html index 1034cc952f..0791b05ccc 100644 --- a/interfaces/MetadataRegistry.html +++ b/interfaces/MetadataRegistry.html @@ -22,7 +22,7 @@

    Hierarchy

    • MetadataRegistry
    +
  • Defined in registry/types.ts:12
    • @@ -46,7 +46,7 @@

    Type declaration

  • [childTypeId: string]: string
    • +
  • Defined in registry/types.ts:18

    • strictDirectoryNames

    strictDirectoryNames: {
        [directoryName: string]: string;
    }
    @@ -56,17 +56,17 @@

    Type declaration

  • [directoryName: string]: string
    • +
  • Defined in registry/types.ts:15

    • suffixes

    suffixes: SuffixIndex
    +
  • Defined in registry/types.ts:14

    • types

    types: TypeIndex
    +
  • Defined in registry/types.ts:13
    • diff --git a/interfaces/MetadataRequestStatus.html b/interfaces/MetadataRequestStatus.html index 917c9c83d7..22426b60a2 100644 --- a/interfaces/MetadataRequestStatus.html +++ b/interfaces/MetadataRequestStatus.html @@ -20,7 +20,7 @@

    Hierarchy

    +
  • Defined in client/types.ts:87
    • @@ -39,22 +39,22 @@

    Properties

    done

    done: boolean
    +
  • Defined in client/types.ts:91

    • id

    id: string
    +
  • Defined in client/types.ts:88

    • status

    status: RequestStatus
    +
  • Defined in client/types.ts:89

    • success

    success: boolean
    +
  • Defined in client/types.ts:90
    • diff --git a/interfaces/MetadataTransformer.html b/interfaces/MetadataTransformer.html index 2599a336cf..3c88c77502 100644 --- a/interfaces/MetadataTransformer.html +++ b/interfaces/MetadataTransformer.html @@ -21,7 +21,7 @@

    Hierarchy

    • MetadataTransformer
    +
  • Defined in convert/types.ts:73
    • @@ -42,7 +42,7 @@

    Properties

    Optional defaultDirectory

    defaultDirectory?: string
    +
  • Defined in convert/types.ts:74

    • Methods

    @@ -57,7 +57,7 @@

    Parameters

    component: SourceComponent

    Returns Promise<WriteInfo[]>

    +
  • Defined in convert/types.ts:75

    • toSourceFormat

    Returns Promise<WriteInfo[]>

    +
  • Defined in convert/types.ts:76
    • diff --git a/interfaces/MetadataType.html b/interfaces/MetadataType.html index 6c2cff0724..58a2619df5 100644 --- a/interfaces/MetadataType.html +++ b/interfaces/MetadataType.html @@ -21,7 +21,7 @@

    Hierarchy

    • MetadataType
    +
  • Defined in registry/types.ts:26
    • @@ -59,7 +59,7 @@

    Optional

    Whenever this type is requested, return the aliasFor type instead

    +
  • Defined in registry/types.ts:127

    • Optional children

    children?: {
        directories?: DirectoryIndex;
        suffixes: SuffixIndex;
        types: TypeIndex;
    }
    @@ -76,42 +76,42 @@
    suffixes:
    types: TypeIndex
    +
  • Defined in registry/types.ts:133

    • directoryName

    directoryName: string

    Name of the directory where components are located in a package.

    +
  • Defined in registry/types.ts:38

    • Optional folderContentType

    folderContentType?: string

    If the type is a folder type (container for components), the id of the type it is a container for.

    +
  • Defined in registry/types.ts:75

    • Optional folderType

    folderType?: string

    If the type is contained in folders, the id of the type that contains it.

    +
  • Defined in registry/types.ts:79

    • id

    id: string

    Unique identifier of the metadata type. Usually the API name lowercased.

    +
  • Defined in registry/types.ts:30

    • Optional ignoreParentName

    ignoreParentName?: boolean

    If the parent name should be ignored when constructing the type's fullName

    +
  • Defined in registry/types.ts:83

    • Optional ignoreParsedFullName

    ignoreParsedFullName?: boolean
    @@ -119,7 +119,7 @@

    Optional

    +
  • Defined in registry/types.ts:71

    • Optional inFolder

    inFolder?: boolean
    @@ -129,14 +129,14 @@

    OptionalDeprecated

    use folderType to get the related folder type, if one exists

    +
  • Defined in registry/types.ts:46

    • Optional isAddressable

    isAddressable?: boolean

    Whether the component is supported by the Metadata API and therefore should be included within a manifest.

    +
  • Defined in registry/types.ts:100

    • Optional legacySuffix

    legacySuffix?: string
    @@ -144,7 +144,7 @@

    Optional

    +
  • Defined in registry/types.ts:92

    • Optional metaFileSuffix

    metaFileSuffix?: string
    @@ -153,14 +153,14 @@

    OptionalExamples: "_meta.json" for DigitalExperience.

    +
  • Defined in registry/types.ts:62

    • name

    name: string

    API name of the metadata type.

    +
  • Defined in registry/types.ts:34

    • Optional strategies

    strategies?: {
        adapter: "sourceAdapter" | "mixedContent" | "matchingContentFile" | "decomposed" | "nonDecomposed" | "digitalExperience" | "bundle";
        decomposition?: "topLevel" | "folderPerType";
        recomposition?: "startEmpty";
        transformer?: "decomposed" | "nonDecomposed" | "staticResource" | "standard";
    }
    @@ -178,14 +178,14 @@
    Optional recomposition
    Optional transformer?: "decomposed" | "nonDecomposed" | "staticResource" | "standard"
    +
  • Defined in registry/types.ts:141

    • Optional strictDirectoryName

    strictDirectoryName?: boolean

    Whether or not components are required to reside in a folder named after the type's directoryName.

    +
  • Defined in registry/types.ts:66

    • Optional suffix

    suffix?: string
    @@ -194,7 +194,7 @@

    OptionalExamples: LightningComponentBundles, Documents, StaticResources

    +
  • Defined in registry/types.ts:54

    • Optional supportsPartialDelete

    supportsPartialDelete?: boolean
    @@ -202,7 +202,7 @@

    OptionalExamples: LightningComponentBundle, ExperienceBundle, StaticResource, and DigitalExperienceBundle

    +
  • Defined in registry/types.ts:122

    • Optional supportsWildcardAndName

    supportsWildcardAndName?: boolean
    @@ -211,28 +211,28 @@

    Optional

    +
  • Defined in registry/types.ts:115

    • Optional unaddressableWithoutParent

    unaddressableWithoutParent?: boolean

    Whether the component requires the parent to be present when deploying/retrieving

    +
  • Defined in registry/types.ts:104

    • Optional uniqueIdElement

    uniqueIdElement?: string

    The xml attribute used as the unique identifier when parsing the xml

    +
  • Defined in registry/types.ts:96

    • Optional xmlElementName

    xmlElementName?: string

    The XML element name for the type in the xml file used for constructing child components.

    +
  • Defined in registry/types.ts:87
    • diff --git a/interfaces/OptionalTreeRegistryOptions.html b/interfaces/OptionalTreeRegistryOptions.html index e0e08e805f..71132f818d 100644 --- a/interfaces/OptionalTreeRegistryOptions.html +++ b/interfaces/OptionalTreeRegistryOptions.html @@ -25,7 +25,7 @@

    Hierarchy

  • FromManifestOptions
  • FromConnectionOptions
    • +
  • Defined in common/types.ts:24
    • @@ -43,13 +43,13 @@

    Optionalregistry?: RegistryAccess

    +
  • Defined in common/types.ts:21

    • Optional tree

    tree?: TreeContainer
    +
  • Defined in common/types.ts:17
    • diff --git a/interfaces/PackageManifestObject.html b/interfaces/PackageManifestObject.html index e9052098cf..aebc6e3e1a 100644 --- a/interfaces/PackageManifestObject.html +++ b/interfaces/PackageManifestObject.html @@ -18,7 +18,7 @@

    Hierarchy

    • PackageManifestObject
    +
  • Defined in collections/types.ts:17
    • @@ -45,7 +45,7 @@
    types:
    version: string
    +
  • Defined in collections/types.ts:18
    • diff --git a/interfaces/PackageOption.html b/interfaces/PackageOption.html index 24d51f4726..d87cf8a9d2 100644 --- a/interfaces/PackageOption.html +++ b/interfaces/PackageOption.html @@ -18,7 +18,7 @@

    Hierarchy

    • PackageOption
    +
  • Defined in client/types.ts:268
    • @@ -37,7 +37,7 @@

    name

    The name of the package to retrieve.

    +
  • Defined in client/types.ts:272

    • Optional outputDir

    outputDir?: string
    @@ -46,7 +46,7 @@

    Optional<process.cwd()>/PackageOption.name.

    +
  • Defined in client/types.ts:278
    • diff --git a/interfaces/PackageTypeMembers.html b/interfaces/PackageTypeMembers.html index ccdf4e1fc5..0d0dba1b71 100644 --- a/interfaces/PackageTypeMembers.html +++ b/interfaces/PackageTypeMembers.html @@ -18,7 +18,7 @@

    Hierarchy

    • PackageTypeMembers
    +
  • Defined in collections/types.ts:12
    • @@ -35,12 +35,12 @@

    Properties

    members

    members: string[]
    +
  • Defined in collections/types.ts:14

    • name

    name: string
    +
  • Defined in collections/types.ts:13
    • diff --git a/interfaces/RegistryOptions.html b/interfaces/RegistryOptions.html index 0d8f8cb5a7..5e51148ae6 100644 --- a/interfaces/RegistryOptions.html +++ b/interfaces/RegistryOptions.html @@ -18,7 +18,7 @@

    Hierarchy

    • RegistryOptions
    +
  • Defined in common/types.ts:20
    • @@ -34,7 +34,7 @@

    Properties

    registry

    registry: RegistryAccess
    +
  • Defined in common/types.ts:21
    • diff --git a/interfaces/RetrieveOptions.html b/interfaces/RetrieveOptions.html index 206409ba11..77bb67a490 100644 --- a/interfaces/RetrieveOptions.html +++ b/interfaces/RetrieveOptions.html @@ -18,7 +18,7 @@

    Hierarchy

    • RetrieveOptions
    +
  • Defined in client/types.ts:298
    • @@ -43,14 +43,14 @@

    Optional

    The file format desired for the retrieved files.

    +
  • Defined in client/types.ts:315

    • Optional merge

    merge?: boolean

    Whether or not to merge and replace input components with the retrieved versions.

    +
  • Defined in client/types.ts:307

    • output

    output: string
    @@ -58,14 +58,14 @@

    output

    +
  • Defined in client/types.ts:303

    • Optional packageOptions

    packageOptions?: PackageOptions

    A list of package names to retrieve, or package names and their retrieval locations.

    +
  • Defined in client/types.ts:311

    • Optional singlePackage

    singlePackage?: boolean
    @@ -73,28 +73,28 @@

    Optional

    +
  • Defined in client/types.ts:320

    • Optional suppressEvents

    suppressEvents?: boolean

    Specifies whether to suppress the <Pre|Post> events

    +
  • Defined in client/types.ts:332

    • Optional unzip

    unzip?: boolean

    Specifies whether to unzip the retrieved zip file. Only applies when format: metadata.

    +
  • Defined in client/types.ts:328

    • Optional zipFileName

    zipFileName?: string

    The name of the retrieved zip file containing the source from the org. Only applies when format: metadata.

    +
  • Defined in client/types.ts:324
    • diff --git a/interfaces/RetrieveVersionData.html b/interfaces/RetrieveVersionData.html index c97d8ea1d2..e519155430 100644 --- a/interfaces/RetrieveVersionData.html +++ b/interfaces/RetrieveVersionData.html @@ -18,7 +18,7 @@

    Hierarchy

    • RetrieveVersionData
    +
  • Defined in client/types.ts:370
    • @@ -35,12 +35,12 @@

    Properties

    apiVersion

    apiVersion: string
    +
  • Defined in client/types.ts:371

    • manifestVersion

    manifestVersion: string
    +
  • Defined in client/types.ts:372
    • diff --git a/interfaces/RunTestResult.html b/interfaces/RunTestResult.html index 0a1b4e711d..0a8926c021 100644 --- a/interfaces/RunTestResult.html +++ b/interfaces/RunTestResult.html @@ -18,7 +18,7 @@

    Hierarchy

    • RunTestResult
    +
  • Defined in client/types.ts:144
    • @@ -40,37 +40,37 @@

    Properties

    Optional codeCoverage

    codeCoverage?: CodeCoverage | CodeCoverage[]
    +
  • Defined in client/types.ts:145

    • Optional codeCoverageWarnings

    codeCoverageWarnings?: CodeCoverageWarnings | CodeCoverageWarnings[]
    +
  • Defined in client/types.ts:146

    • Optional failures

    failures?: Failures | Failures[]
    +
  • Defined in client/types.ts:147

    • numFailures

    numFailures: string
    +
  • Defined in client/types.ts:148

    • numTestsRun

    numTestsRun: string
    +
  • Defined in client/types.ts:149

    • Optional successes

    successes?: Successes | Successes[]
    +
  • Defined in client/types.ts:150

    • totalTime

    totalTime: string
    +
  • Defined in client/types.ts:151
    • diff --git a/interfaces/ScopedPostDeploy.html b/interfaces/ScopedPostDeploy.html index 930bde8c00..ff059f593b 100644 --- a/interfaces/ScopedPostDeploy.html +++ b/interfaces/ScopedPostDeploy.html @@ -21,7 +21,7 @@

    Hierarchy

    • ScopedPostDeploy
    +
  • Defined in client/metadataApiDeploy.ts:496
    • @@ -38,12 +38,12 @@

    Properties

    deployResult

    deployResult: DeployResult
    +
  • Defined in client/metadataApiDeploy.ts:497

    • orgId

    orgId: string
    +
  • Defined in client/metadataApiDeploy.ts:498
    • diff --git a/interfaces/ScopedPostRetrieve.html b/interfaces/ScopedPostRetrieve.html index a8b3166f43..d7561a3005 100644 --- a/interfaces/ScopedPostRetrieve.html +++ b/interfaces/ScopedPostRetrieve.html @@ -21,7 +21,7 @@

    Hierarchy

    • ScopedPostRetrieve
    +
  • Defined in client/metadataApiRetrieve.ts:418
    • @@ -38,12 +38,12 @@

    Properties

    orgId

    orgId: string
    +
  • Defined in client/metadataApiRetrieve.ts:420

    • retrieveResult

    retrieveResult: RetrieveResult
    +
  • Defined in client/metadataApiRetrieve.ts:419
    • diff --git a/interfaces/ScopedPreDeploy.html b/interfaces/ScopedPreDeploy.html index 65b3a8cdf0..6b28074984 100644 --- a/interfaces/ScopedPreDeploy.html +++ b/interfaces/ScopedPreDeploy.html @@ -21,7 +21,7 @@

    Hierarchy

    • ScopedPreDeploy
    +
  • Defined in client/metadataApiDeploy.ts:488
    • @@ -38,12 +38,12 @@

    Properties

    componentSet

    componentSet: ComponentSet
    +
  • Defined in client/metadataApiDeploy.ts:489

    • orgId

    orgId: string
    +
  • Defined in client/metadataApiDeploy.ts:490
    • diff --git a/interfaces/ScopedPreRetrieve.html b/interfaces/ScopedPreRetrieve.html index 5e8a24c187..e9ce78ab84 100644 --- a/interfaces/ScopedPreRetrieve.html +++ b/interfaces/ScopedPreRetrieve.html @@ -21,7 +21,7 @@

    Hierarchy

    • ScopedPreRetrieve
    +
  • Defined in client/metadataApiRetrieve.ts:410
    • @@ -38,12 +38,12 @@

    Properties

    componentSet

    componentSet: ComponentSet
    +
  • Defined in client/metadataApiRetrieve.ts:411

    • orgId

    orgId: string
    +
  • Defined in client/metadataApiRetrieve.ts:412
    • diff --git a/interfaces/SourceAdapter.html b/interfaces/SourceAdapter.html index e4a1f3989c..afdfb5a363 100644 --- a/interfaces/SourceAdapter.html +++ b/interfaces/SourceAdapter.html @@ -21,7 +21,7 @@

    Hierarchy

    • SourceAdapter
    +
  • Defined in resolve/types.ts:47
    • @@ -43,7 +43,7 @@

    allowMetadataWithContent

    Returns boolean

    +
  • Defined in resolve/types.ts:59

    • getComponent

      @@ -64,7 +64,7 @@
      Optional isResolvingSource:

    Returns undefined | SourceComponent

    +
  • Defined in resolve/types.ts:54
    • diff --git a/interfaces/Successes.html b/interfaces/Successes.html index 531ad37f98..0ab31f230c 100644 --- a/interfaces/Successes.html +++ b/interfaces/Successes.html @@ -18,7 +18,7 @@

    Hierarchy

    • Successes
    +
  • Defined in client/types.ts:187
    • @@ -37,22 +37,22 @@

    Properties

    id

    id: string
    +
  • Defined in client/types.ts:188

    • methodName

    methodName: string
    +
  • Defined in client/types.ts:189

    • name

    name: string
    +
  • Defined in client/types.ts:190

    • time

    time: string
    +
  • Defined in client/types.ts:191
    • diff --git a/interfaces/TreeOptions.html b/interfaces/TreeOptions.html index 1c3b6165fa..9685118f9d 100644 --- a/interfaces/TreeOptions.html +++ b/interfaces/TreeOptions.html @@ -18,7 +18,7 @@

    Hierarchy

    • TreeOptions
    +
  • Defined in common/types.ts:16
    • @@ -34,7 +34,7 @@

    Properties

    tree

    tree: TreeContainer
    +
  • Defined in common/types.ts:17
    • diff --git a/interfaces/_internal_.DirectoryIndex.html b/interfaces/_internal_.DirectoryIndex.html index 74765e6bf0..13ad52e301 100644 --- a/interfaces/_internal_.DirectoryIndex.html +++ b/interfaces/_internal_.DirectoryIndex.html @@ -25,7 +25,7 @@

    Hierarchy

    Indexable

    [directoryName: string]: string
    +
  • Defined in registry/types.ts:173
    • diff --git a/interfaces/_internal_.FileResponseBase.html b/interfaces/_internal_.FileResponseBase.html index dc53ca9ed8..811c23960d 100644 --- a/interfaces/_internal_.FileResponseBase.html +++ b/interfaces/_internal_.FileResponseBase.html @@ -22,7 +22,7 @@

    Hierarchy

  • FileResponseFailure
  • FileResponseSuccess
    • +
  • Defined in client/types.ts:48
    • @@ -40,17 +40,17 @@

    Properties

    Optional filePath

    filePath?: string
    +
  • Defined in client/types.ts:51

    • fullName

    fullName: string
    +
  • Defined in client/types.ts:49

    • type

    type: string
    +
  • Defined in client/types.ts:50
    • diff --git a/interfaces/_internal_.FromConnectionOptions.html b/interfaces/_internal_.FromConnectionOptions.html index ce4bcfdc04..bfba61a3cf 100644 --- a/interfaces/_internal_.FromConnectionOptions.html +++ b/interfaces/_internal_.FromConnectionOptions.html @@ -21,7 +21,7 @@

    Hierarchy

    • FromConnectionOptions
    +
  • Defined in collections/types.ts:78
    • @@ -43,7 +43,7 @@

    Optional

    the metadata API version to use

    +
  • Defined in collections/types.ts:86

    • Optional componentFilter

    componentFilter?: ((component: Partial<FileProperties>) => boolean)
    @@ -63,26 +63,26 @@

    Parameters

    component: Partial<FileProperties>

    Returns boolean

    +
  • Defined in collections/types.ts:90

    • Optional registry

    registry?: RegistryAccess
    +
  • Defined in common/types.ts:21

    • Optional tree

    tree?: TreeContainer
    +
  • Defined in common/types.ts:17

    • usernameOrConnection

    usernameOrConnection: string | Connection<Schema>

    username or connection to an org

    +
  • Defined in collections/types.ts:82
    • diff --git a/interfaces/_internal_.ListMetadataQuery.html b/interfaces/_internal_.ListMetadataQuery.html index 42db9c1be9..69d13a574a 100644 --- a/interfaces/_internal_.ListMetadataQuery.html +++ b/interfaces/_internal_.ListMetadataQuery.html @@ -19,7 +19,7 @@

    Hierarchy

    • ListMetadataQuery
    +
  • Defined in client/types.ts:359
    • @@ -36,12 +36,12 @@

    Properties

    Optional folder

    folder?: string
    +
  • Defined in client/types.ts:361

    • type

    type: string
    +
  • Defined in client/types.ts:360
    • diff --git a/interfaces/_internal_.MetadataApiDeployOptions.html b/interfaces/_internal_.MetadataApiDeployOptions.html index 86f1051516..bda446424a 100644 --- a/interfaces/_internal_.MetadataApiDeployOptions.html +++ b/interfaces/_internal_.MetadataApiDeployOptions.html @@ -19,7 +19,7 @@

    Hierarchy

    • MetadataApiDeployOptions
    +
  • Defined in client/types.ts:335
    • @@ -46,64 +46,64 @@

    Properties

    Optional allowMissingFiles

    allowMissingFiles?: boolean
    +
  • Defined in client/types.ts:336

    • Optional autoUpdatePackage

    autoUpdatePackage?: boolean
    +
  • Defined in client/types.ts:337

    • Optional checkOnly

    checkOnly?: boolean
    +
  • Defined in client/types.ts:338

    • Optional ignoreWarnings

    ignoreWarnings?: boolean
    +
  • Defined in client/types.ts:339

    • Optional performRetrieve

    performRetrieve?: boolean
    +
  • Defined in client/types.ts:340

    • Optional purgeOnDelete

    purgeOnDelete?: boolean
    +
  • Defined in client/types.ts:341

    • Optional rest

    rest?: boolean

    Set to true to use the REST API for deploying.

    +
  • Defined in client/types.ts:350

    • Optional rollbackOnError

    rollbackOnError?: boolean
    +
  • Defined in client/types.ts:342

    • Optional runAllTests

    runAllTests?: boolean
    +
  • Defined in client/types.ts:343

    • Optional runTests

    runTests?: string[]
    +
  • Defined in client/types.ts:344

    • Optional singlePackage

    singlePackage?: boolean
    +
  • Defined in client/types.ts:345

    • Optional testLevel

    testLevel?: "NoTestRun" | "RunSpecifiedTests" | "RunLocalTests" | "RunAllTestsInOrg"
    +
  • Defined in client/types.ts:346
    • diff --git a/interfaces/_internal_.MetadataTransferOptions.html b/interfaces/_internal_.MetadataTransferOptions.html index 46bb92bbbd..281de0e97e 100644 --- a/interfaces/_internal_.MetadataTransferOptions.html +++ b/interfaces/_internal_.MetadataTransferOptions.html @@ -21,7 +21,7 @@

    Hierarchy

    +
  • Defined in client/metadataTransfer.ts:29
    • @@ -40,22 +40,22 @@

    Properties

    Optional apiVersion

    apiVersion?: string
    +
  • Defined in client/metadataTransfer.ts:32

    • Optional components

    components?: ComponentSet
    +
  • Defined in client/metadataTransfer.ts:31

    • Optional id

    id?: string
    +
  • Defined in client/metadataTransfer.ts:33

    • usernameOrConnection

    usernameOrConnection: string | Connection<Schema>
    +
  • Defined in client/metadataTransfer.ts:30
    • diff --git a/interfaces/_internal_.MetadataTransferResult.html b/interfaces/_internal_.MetadataTransferResult.html index 52573fe29a..f7ef9714b7 100644 --- a/interfaces/_internal_.MetadataTransferResult.html +++ b/interfaces/_internal_.MetadataTransferResult.html @@ -24,7 +24,7 @@

    Implemented by

  • DeployResult
  • RetrieveResult
    • +
  • Defined in client/types.ts:67
    • @@ -45,12 +45,12 @@

    Properties

    Optional components

    components?: ComponentSet
    +
  • Defined in client/types.ts:69

    • response

    response: MetadataRequestStatus
    +
  • Defined in client/types.ts:68

    • Methods

    @@ -60,7 +60,7 @@

    getFileResponses

    Returns FileResponse[]

    +
  • Defined in client/types.ts:70
    • diff --git a/interfaces/_internal_.ResolveConnectionResult.html b/interfaces/_internal_.ResolveConnectionResult.html index 0ec8ead864..0dad14d7d2 100644 --- a/interfaces/_internal_.ResolveConnectionResult.html +++ b/interfaces/_internal_.ResolveConnectionResult.html @@ -19,7 +19,7 @@

    Hierarchy

    • ResolveConnectionResult
    +
  • Defined in resolve/connectionResolver.ts:21
    • @@ -36,12 +36,12 @@

    Properties

    apiVersion

    apiVersion: string
    +
  • Defined in resolve/connectionResolver.ts:23

    • components

    components: MetadataComponent[]
    +
  • Defined in resolve/connectionResolver.ts:22
    • diff --git a/interfaces/_internal_.ResolveManifestResult.html b/interfaces/_internal_.ResolveManifestResult.html index f0cb92e22e..eff872b597 100644 --- a/interfaces/_internal_.ResolveManifestResult.html +++ b/interfaces/_internal_.ResolveManifestResult.html @@ -19,7 +19,7 @@

    Hierarchy

    • ResolveManifestResult
    +
  • Defined in resolve/manifestResolver.ts:35
    • @@ -37,17 +37,17 @@

    Properties

    apiVersion

    apiVersion: string
    +
  • Defined in resolve/manifestResolver.ts:37

    • components

    components: MetadataComponent[]
    +
  • Defined in resolve/manifestResolver.ts:36

    • Optional fullName

    fullName?: string
    +
  • Defined in resolve/manifestResolver.ts:38
    • diff --git a/interfaces/_internal_.SuffixIndex.html b/interfaces/_internal_.SuffixIndex.html index e83115900c..0379ab2795 100644 --- a/interfaces/_internal_.SuffixIndex.html +++ b/interfaces/_internal_.SuffixIndex.html @@ -25,7 +25,7 @@

    Hierarchy

    Indexable

    [suffix: string]: string
    +
  • Defined in registry/types.ts:166
    • diff --git a/interfaces/_internal_.TypeIndex.html b/interfaces/_internal_.TypeIndex.html index dd2b87af10..c702c2f8bb 100644 --- a/interfaces/_internal_.TypeIndex.html +++ b/interfaces/_internal_.TypeIndex.html @@ -25,7 +25,7 @@

    Hierarchy

    Indexable

    [typeId: string]: MetadataType
    +
  • Defined in registry/types.ts:159
    • diff --git a/interfaces/_internal_.ZipEntry.html b/interfaces/_internal_.ZipEntry.html index 976d52bdeb..5d9f0d48bb 100644 --- a/interfaces/_internal_.ZipEntry.html +++ b/interfaces/_internal_.ZipEntry.html @@ -19,7 +19,7 @@

    Hierarchy

    • ZipEntry
    +
  • Defined in resolve/treeContainers.ts:123
    • @@ -45,12 +45,12 @@

    Type declaration

  • Returns Promise<Buffer>

    • +
  • Defined in resolve/treeContainers.ts:126

    • path

    path: string
    +
  • Defined in resolve/treeContainers.ts:124

    • Optional stream

    stream?: (() => Entry)
    @@ -63,7 +63,7 @@

    Type declaration

  • Returns Entry

    • +
  • Defined in resolve/treeContainers.ts:125
    • diff --git a/types/ComponentDeployment.html b/types/ComponentDeployment.html index e629d1ec7d..5749f3456a 100644 --- a/types/ComponentDeployment.html +++ b/types/ComponentDeployment.html @@ -26,7 +26,7 @@
    Optional id
    status: ComponentStatus
    +
  • Defined in client/types.ts:27
    • diff --git a/types/ComponentDiagnostic.html b/types/ComponentDiagnostic.html index dad4c594ba..4032dcb0f2 100644 --- a/types/ComponentDiagnostic.html +++ b/types/ComponentDiagnostic.html @@ -28,7 +28,7 @@
    Optional lineNumber
    problemType: "Warning" | "Error"
    +
  • Defined in client/types.ts:40
    • diff --git a/types/ComponentLike.html b/types/ComponentLike.html index 95e36a2d9d..e16c3392b3 100644 --- a/types/ComponentLike.html +++ b/types/ComponentLike.html @@ -15,7 +15,7 @@

    Type alias ComponentLike

    ComponentLike: MetadataComponent | MetadataMember
    +
  • Defined in resolve/types.ts:23
    • diff --git a/types/ComponentRetrieval.html b/types/ComponentRetrieval.html index b0258c26e6..75c427ff26 100644 --- a/types/ComponentRetrieval.html +++ b/types/ComponentRetrieval.html @@ -24,7 +24,7 @@
    Optional diagnostics
    Optional status?: RequestStatus
    +
  • Defined in client/types.ts:34
    • diff --git a/types/ComponentSetOptions.html b/types/ComponentSetOptions.html index f54dd6dd45..dfe23716a0 100644 --- a/types/ComponentSetOptions.html +++ b/types/ComponentSetOptions.html @@ -32,7 +32,7 @@
    Optional sourceapiversion
    Optional sourcepath?: string[]
    +
  • Defined in collections/componentSetBuilder.ts:36
    • diff --git a/types/ConvertOutputConfig.html b/types/ConvertOutputConfig.html index adcbcc5a46..94dc6520a0 100644 --- a/types/ConvertOutputConfig.html +++ b/types/ConvertOutputConfig.html @@ -15,7 +15,7 @@

    Type alias ConvertOutputConfig

    ConvertOutputConfig: DirectoryConfig | ZipConfig | MergeConfig
    +
  • Defined in convert/types.ts:92
    • diff --git a/types/ConvertResult.html b/types/ConvertResult.html index 588e358098..7b9341aa21 100644 --- a/types/ConvertResult.html +++ b/types/ConvertResult.html @@ -30,7 +30,7 @@
    Optional zipBuffer

    Buffer of converted package. Undefined if outputDirectory is omitted from zip output config.

    +
  • Defined in convert/types.ts:94
    • diff --git a/types/DeployDetails.html b/types/DeployDetails.html index 6af8753989..5a4baba975 100644 --- a/types/DeployDetails.html +++ b/types/DeployDetails.html @@ -24,7 +24,7 @@
    Optional componentSuccess
  • Optional runTestResult?: RunTestResult
    • +
  • Defined in client/types.ts:136
    • diff --git a/types/DeployMessage.html b/types/DeployMessage.html index 38e4c2d2e1..9458407270 100644 --- a/types/DeployMessage.html +++ b/types/DeployMessage.html @@ -44,7 +44,7 @@
    Optional problemType
    success: BooleanString
    +
  • Defined in client/types.ts:196
    • diff --git a/types/DeploySetOptions.html b/types/DeploySetOptions.html index 39d3543d0f..2cf5634fdf 100644 --- a/types/DeploySetOptions.html +++ b/types/DeploySetOptions.html @@ -15,7 +15,7 @@

    Type alias DeploySetOptions

    DeploySetOptions: Omit<MetadataApiDeployOptions, "components">
    +
  • Defined in collections/componentSet.ts:41
    • diff --git a/types/DirectoryConfig.html b/types/DirectoryConfig.html index d35f79dca7..710421b709 100644 --- a/types/DirectoryConfig.html +++ b/types/DirectoryConfig.html @@ -15,7 +15,7 @@

    Type alias DirectoryConfig

    DirectoryConfig: PackageName & UniqueOutputDir & {
        outputDirectory: SourcePath;
        type: "directory";
    }
    +
  • Defined in convert/types.ts:39
    • diff --git a/types/FileProperties.html b/types/FileProperties.html index c00ddc4b3a..188a8d4733 100644 --- a/types/FileProperties.html +++ b/types/FileProperties.html @@ -42,7 +42,7 @@
    Optional namespacePrefix<
  • type: string
    • +
  • Defined in client/types.ts:235
    • diff --git a/types/FileResponse.html b/types/FileResponse.html index f83de3dfcb..fdb5543fe9 100644 --- a/types/FileResponse.html +++ b/types/FileResponse.html @@ -15,7 +15,7 @@

    Type alias FileResponse

    FileResponse: FileResponseSuccess | FileResponseFailure
    +
  • Defined in client/types.ts:66
    • diff --git a/types/MergeConfig.html b/types/MergeConfig.html index c4b8a0bf29..476c1d8f5f 100644 --- a/types/MergeConfig.html +++ b/types/MergeConfig.html @@ -30,7 +30,7 @@
    mergeWith:
    type: "merge"
    +
  • Defined in convert/types.ts:57
    • diff --git a/types/MetadataApiRetrieveOptions.html b/types/MetadataApiRetrieveOptions.html index 8398b44bad..6ad3633827 100644 --- a/types/MetadataApiRetrieveOptions.html +++ b/types/MetadataApiRetrieveOptions.html @@ -15,7 +15,7 @@

    Type alias MetadataApiRetrieveOptions

    MetadataApiRetrieveOptions: MetadataTransferOptions & RetrieveOptions & {
        registry?: RegistryAccess;
    }
    +
  • Defined in client/metadataApiRetrieve.ts:35
    • diff --git a/types/MetadataXml.html b/types/MetadataXml.html index 0be1c62439..6ddeec67e4 100644 --- a/types/MetadataXml.html +++ b/types/MetadataXml.html @@ -26,7 +26,7 @@
    path:
    Optional suffix?: string
    +
  • Defined in resolve/types.ts:28
    • diff --git a/types/PackageOptions.html b/types/PackageOptions.html index c25f50ed6c..50a4ede1ca 100644 --- a/types/PackageOptions.html +++ b/types/PackageOptions.html @@ -15,7 +15,7 @@

    Type alias PackageOptions

    PackageOptions: string[] | PackageOption[]
    +
  • Defined in client/types.ts:281
    • diff --git a/types/RetrieveFailure.html b/types/RetrieveFailure.html index 7e43e12d4c..c69aa0f9d2 100644 --- a/types/RetrieveFailure.html +++ b/types/RetrieveFailure.html @@ -22,7 +22,7 @@
    Optional component
    message: string
    +
  • Defined in client/types.ts:94
    • diff --git a/types/RetrieveMessage.html b/types/RetrieveMessage.html index 02017f7e02..ce74964f50 100644 --- a/types/RetrieveMessage.html +++ b/types/RetrieveMessage.html @@ -22,7 +22,7 @@
    fileName:
    problem: string
    +
  • Defined in client/types.ts:222
    • diff --git a/types/RetrieveRequest.html b/types/RetrieveRequest.html index 2363f5b11d..6601d6ef52 100644 --- a/types/RetrieveRequest.html +++ b/types/RetrieveRequest.html @@ -31,7 +31,7 @@
    Optional unpackaged
    types: PackageTypeMembers[]
    +
  • Defined in client/types.ts:212
    • diff --git a/types/RetrieveSetOptions.html b/types/RetrieveSetOptions.html index c411bf1cbb..1856154fd1 100644 --- a/types/RetrieveSetOptions.html +++ b/types/RetrieveSetOptions.html @@ -15,7 +15,7 @@

    Type alias RetrieveSetOptions

    RetrieveSetOptions: Omit<MetadataApiRetrieveOptions, "components">
    +
  • Defined in collections/componentSet.ts:42
    • diff --git a/types/RetrieveSuccess.html b/types/RetrieveSuccess.html index ee08a4a38e..bbcd71c644 100644 --- a/types/RetrieveSuccess.html +++ b/types/RetrieveSuccess.html @@ -22,7 +22,7 @@
    component:
    Optional properties?: FileProperties
    +
  • Defined in client/types.ts:99
    • diff --git a/types/SfdxFileFormat.html b/types/SfdxFileFormat.html index e0279de800..ac4972680d 100644 --- a/types/SfdxFileFormat.html +++ b/types/SfdxFileFormat.html @@ -19,7 +19,7 @@

    Type alias SfdxFileFormat

    source - Friendly for local editing and committing files to source control.

    +
  • Defined in convert/types.ts:90
    • diff --git a/types/SourcePath.html b/types/SourcePath.html index cd5f0f6eda..11b191133c 100644 --- a/types/SourcePath.html +++ b/types/SourcePath.html @@ -17,7 +17,7 @@

    Type alias SourcePath

    File system path to a source file of a metadata component.

    +
  • Defined in common/types.ts:14
    • diff --git a/types/VirtualDirectory.html b/types/VirtualDirectory.html index 99b5e3dbc5..8fdb2ae23a 100644 --- a/types/VirtualDirectory.html +++ b/types/VirtualDirectory.html @@ -22,7 +22,7 @@
    children:
    dirPath: SourcePath
    +
  • Defined in resolve/types.ts:39
    • diff --git a/types/VirtualFile.html b/types/VirtualFile.html index 31b1073f13..de09565adf 100644 --- a/types/VirtualFile.html +++ b/types/VirtualFile.html @@ -22,7 +22,7 @@
    Optional data
    name: string
    +
  • Defined in resolve/types.ts:34
    • diff --git a/types/WriteInfo.html b/types/WriteInfo.html index 4e640ffc8c..d3b30a60fc 100644 --- a/types/WriteInfo.html +++ b/types/WriteInfo.html @@ -22,7 +22,7 @@
    output:
    source: Readable
    +
  • Defined in convert/types.ts:15
    • diff --git a/types/WriterFormat.html b/types/WriterFormat.html index 42c7964469..9c915128be 100644 --- a/types/WriterFormat.html +++ b/types/WriterFormat.html @@ -22,7 +22,7 @@
    component:
    writeInfos: WriteInfo[]
    +
  • Defined in convert/types.ts:20
    • diff --git a/types/ZipConfig.html b/types/ZipConfig.html index d75774b63f..7edcde012a 100644 --- a/types/ZipConfig.html +++ b/types/ZipConfig.html @@ -15,7 +15,7 @@

    Type alias ZipConfig

    ZipConfig: PackageName & UniqueOutputDir & {
        outputDirectory?: SourcePath;
        type: "zip";
    }
    +
  • Defined in convert/types.ts:48
    • diff --git a/types/_internal_.BooleanString.html b/types/_internal_.BooleanString.html index e3fac5afc3..4822216d23 100644 --- a/types/_internal_.BooleanString.html +++ b/types/_internal_.BooleanString.html @@ -16,7 +16,7 @@

    Type alias BooleanString

    BooleanString: "true" | "false" | boolean
    +
  • Defined in client/types.ts:194
    • diff --git a/types/_internal_.ComponentProperties.html b/types/_internal_.ComponentProperties.html index 3728b8ff20..b18b5d6ce1 100644 --- a/types/_internal_.ComponentProperties.html +++ b/types/_internal_.ComponentProperties.html @@ -31,7 +31,7 @@
    type:
    Optional xml?: string
    +
  • Defined in resolve/sourceComponent.ts:28
    • diff --git a/types/_internal_.ManifestOption.html b/types/_internal_.ManifestOption.html index 93912a31df..687e464674 100644 --- a/types/_internal_.ManifestOption.html +++ b/types/_internal_.ManifestOption.html @@ -27,7 +27,7 @@
    directoryPaths:
    manifestPath: string
    +
  • Defined in collections/componentSetBuilder.ts:19
    • diff --git a/types/_internal_.MarkedReplacement.html b/types/_internal_.MarkedReplacement.html index 82a45306b6..c1d98c8795 100644 --- a/types/_internal_.MarkedReplacement.html +++ b/types/_internal_.MarkedReplacement.html @@ -29,7 +29,7 @@
    Optional singleFile
    toReplace: RegExp
    +
  • Defined in convert/types.ts:110
    • diff --git a/types/_internal_.MetadataOption.html b/types/_internal_.MetadataOption.html index a39ffb99dd..fef1267c62 100644 --- a/types/_internal_.MetadataOption.html +++ b/types/_internal_.MetadataOption.html @@ -23,7 +23,7 @@
    directoryPaths:
    metadataEntries: string[]
    +
  • Defined in collections/componentSetBuilder.ts:26
    • diff --git a/types/_internal_.OrgOption.html b/types/_internal_.OrgOption.html index 12276ce10a..b493925495 100644 --- a/types/_internal_.OrgOption.html +++ b/types/_internal_.OrgOption.html @@ -23,7 +23,7 @@
    exclude:
    username: string
    +
  • Defined in collections/componentSetBuilder.ts:31
    • diff --git a/types/_internal_.PackageName.html b/types/_internal_.PackageName.html index 949e6231c5..8531c0a4d5 100644 --- a/types/_internal_.PackageName.html +++ b/types/_internal_.PackageName.html @@ -23,7 +23,7 @@
    Optional packageName

    Optional name to give to the package, otherwise one is generated.

    +
  • Defined in convert/types.ts:25
    • diff --git a/types/_internal_.UniqueOutputDir.html b/types/_internal_.UniqueOutputDir.html index 851c92ce95..1de90cb6b6 100644 --- a/types/_internal_.UniqueOutputDir.html +++ b/types/_internal_.UniqueOutputDir.html @@ -23,7 +23,7 @@
    Optional genUniqueD

    Whether to generate a unique directory within the outputDirectory. Default is true.

    +
  • Defined in convert/types.ts:32
    • diff --git a/variables/registry.html b/variables/registry.html index 35a95fea4e..2a6c754d97 100644 --- a/variables/registry.html +++ b/variables/registry.html @@ -17,7 +17,7 @@

    Variable registryConst

    The default metadata registry.

    +
  • Defined in registry/registry.ts:14