Class PackageProfileApi

constructor

• new PackageProfileApi(options: ProfileApiOptions): PackageProfileApi

  Parameters

  • options: ProfileApiOptions

  Returns PackageProfileApi

includeUserLicenses

project

filterAndGenerateProfilesForManifest

• filterAndGenerateProfilesForManifest(
      typesArr: PackageTypeMembers[],
      excludedDirectories?: string[],
  ): PackageTypeMembers[]

  Filter out all profiles in the manifest and if any profiles exist in the project package directories, add them to the manifest.

  Parameters

  • typesArr: PackageTypeMembers[]

    array of objects { name[], members[] } that represent package types JSON.

  • excludedDirectories: string[] = []

    Direcotires not to generate profiles for

  Returns PackageTypeMembers[]

generateProfiles

• generateProfiles(
      destPath: string,
      manifestTypes: PackageTypeMembers[],
      excludedDirectories?: string[],
  ): string[]

  For any profile present in the project package directories, this function generates a subset of data that only contains references to items in the manifest.

  return a list of profile file locations that need to be removed from the package because they are empty

  Parameters

  • destPath: string

    location of new profiles

  • manifestTypes: PackageTypeMembers[]
  • excludedDirectories: string[] = []

    Directories to not include profiles from

  Returns string[]

init

• init(): Promise<void>

  Asynchronously initializes newly constructed instances of a concrete subclass.

  Returns Promise<void>