Class PackageManifest

Object that describe the salesforce package XML, can be converted into a package.xml file body or JSON structure

Index

Constructors

constructor

new PackageManifest(): PackageManifest
Returns PackageManifest

Properties

`Private` `Readonly`metadataMembers

metadataMembers: Map<string, Set<string>> = ...

Accessors

isEmpty

get isEmpty(): boolean
Returns true if the package is empty otherwise false

Returns boolean
- Defined in packages/salesforce/src/deploy/maifest.ts:46

Methods

add

add(type: string, member: string | Iterable<string, any, any>): void
Add a new member(s) to the package XML manifest
Parameters
- type: string
  Type of component to add
- member: string | Iterable<string, any, any>
  Name of the component(s) to add
Returns void
- Defined in packages/salesforce/src/deploy/maifest.ts:96

components

components(): Generator<
    { componentName: string; componentType: string },
    void,
    any,
>
Get all types that are mentioned in this package.

Returns Generator<{ componentName: string; componentType: string }, void, any>
- Defined in packages/salesforce/src/deploy/maifest.ts:60

componentsNames

componentsNames(): string[]
Get all component names in this package as strings in the format type/name

Returns string[]
Array of component names in the format type/name
Example
```
`ApexClass/MyClass`
```
- Defined in packages/salesforce/src/deploy/maifest.ts:71

count

count(type?: string): number
Count the number of package members in the current manifest
Parameters
- Optionaltype: string
  The XML type to count
Returns number
- Defined in packages/salesforce/src/deploy/maifest.ts:166

filter

filter(
metadataTypes: string | string[] | ((type: string, name: string) => any),
): PackageManifest
Gets a new package manifest with just the specified metadata types. If no metadata types are specified a copy of the current manifest is returned.
Parameters
- metadataTypes: string | string[] | ((type: string, name: string) => any)
  Filter expression or metadata types to include in the new manifest
Returns PackageManifest
- Defined in packages/salesforce/src/deploy/maifest.ts:211

has

has(type: string): boolean
Determine if the specified type exists in the current manifest and has members
Parameters
- type: string
Returns boolean
- Defined in packages/salesforce/src/deploy/maifest.ts:177

list

list(type?: string): string[]
Get a list of all components of the specified type in this package
Parameters
- Optionaltype: string
  The XML type to list the components from
Returns string[]
- Defined in packages/salesforce/src/deploy/maifest.ts:155

merge

merge(other: PackageManifest): this
Merge another package into this package
Parameters
- other: PackageManifest
  Other package to merge into this package
Returns this
This manifest with all members of the other package added
- Defined in packages/salesforce/src/deploy/maifest.ts:84

remove

remove(type: string, member?: string | Iterable<string, any, any>): void
Removes one or more members from the manifest, if no member is specified all members of the specified type are removed.
Parameters
- type: string
  Type of component to remove
- Optionalmember: string | Iterable<string, any, any>
  If specified, the name of the component to remove. If not specified, all components of the specified type are removed.
Returns void
- Defined in packages/salesforce/src/deploy/maifest.ts:131

toJson

toJson(
    apiVersion: string,
): {
    $?: Record<string, undefined | string>;
    types: { members: string[]; name: string }[];
    version: string;
}
Converts the contents of the package to a JSON structure that can be use for retrieval
Parameters
- apiVersion: string
Returns {
    $?: Record<string, undefined | string>;
    types: { members: string[]; name: string }[];
    version: string;
}
- Defined in packages/salesforce/src/deploy/maifest.ts:184

toXml

toXml(apiVersion: string): string
Converts the contents of the package to XML that can be saved into a package.xml file
Parameters
- apiVersion: string
Returns string
- Defined in packages/salesforce/src/deploy/maifest.ts:198

types

types(): string[]
Get all types that are mentioned in this package.

Returns string[]
- Defined in packages/salesforce/src/deploy/maifest.ts:53

`Static`from

from(
manifest: string | Buffer<ArrayBufferLike> | MetadataManifest,
): PackageManifest
Creates a package XML structure object from a MetadataManifest
Parameters
- manifest: string | Buffer<ArrayBufferLike> | MetadataManifest
  The manifest to create a PackageXML from
Returns PackageManifest
- Defined in packages/salesforce/src/deploy/maifest.ts:259

`Static`fromJson

fromJson(
    data:
        | PackageXml
        | {
            $?: Record<string, undefined | string>;
            types: { members: string[]; name: string }[];
            version: string;
        },
): PackageManifest
Creates a new package XML structure object from a JSON structure or a package.xml file
Parameters
- data:
      | PackageXml
      | {
          $?: Record<string, undefined | string>;
          types: { members: string[]; name: string }[];
          version: string;
      }
  Deserialized JSON structure or package.xml file
Returns PackageManifest
New PackageManifest object
- Defined in packages/salesforce/src/deploy/maifest.ts:232

`Static`fromPackageXml

fromPackageXml(manifest: string | Buffer<ArrayBufferLike>): PackageManifest
Deserializes a package.xml file into a package XML structure object
Parameters
- manifest: string | Buffer<ArrayBufferLike>
  Buffer or string containing the package.xml file contents
Returns PackageManifest
New PackageManifest object
- Defined in packages/salesforce/src/deploy/maifest.ts:251

Class PackageManifest

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns PackageManifest

Properties

Private ReadonlymetadataMembers

Accessors

isEmpty

Returns boolean

Methods

add

Parameters

Returns void

components

Returns Generator<{ componentName: string; componentType: string }, void, any>

componentsNames

Returns string[]

Example

count

Parameters

Returns number

filter

Parameters

Returns PackageManifest

has

Parameters

Returns boolean

list

Parameters

Returns string[]

merge

Parameters

Returns this

remove

Parameters

Returns void

toJson

Parameters

Returns { $?: Record<string, undefined | string>; types: { members: string[]; name: string }[]; version: string;}

toXml

Parameters

Returns string

types

Returns string[]

Staticfrom

Parameters

Returns PackageManifest

StaticfromJson

Parameters

Returns PackageManifest

StaticfromPackageXml

Parameters

Returns PackageManifest

Settings

On This Page

`Private` `Readonly`metadataMembers

Returns {
$?: Record<string, undefined | string>;
types: { members: string[]; name: string }[];
version: string;
}

`Static`from

`Static`fromJson

`Static`fromPackageXml