generated from salesforcecli/plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 5
/
list.ts
134 lines (124 loc) · 4.56 KB
/
list.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/*
* Copyright (c) 2022, salesforce.com, inc.
* All rights reserved.
* Licensed under the BSD 3-Clause license.
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
*/
import { Flags, loglevel, orgApiVersionFlagWithDeprecations, SfCommand } from '@salesforce/sf-plugins-core';
import { Messages } from '@salesforce/core';
import { Package, PackagingSObjects } from '@salesforce/packaging';
import chalk from 'chalk';
import { requiredHubFlag } from '../../utils/hubFlag.js';
Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
const messages = Messages.loadMessages('@salesforce/plugin-packaging', 'package_list');
export type Package2Result = Partial<
Pick<
PackagingSObjects.Package2,
| 'Id'
| 'SubscriberPackageId'
| 'Name'
| 'Description'
| 'NamespacePrefix'
| 'ContainerOptions'
| 'ConvertedFromPackageId'
| 'PackageErrorUsername'
| 'AppAnalyticsEnabled'
> & {
Alias: string;
CreatedBy: string;
IsOrgDependent: string;
}
>;
export type PackageListCommandResult = Package2Result[];
export class PackageListCommand extends SfCommand<PackageListCommandResult> {
public static readonly summary = messages.getMessage('summary');
public static readonly description = messages.getMessage('description');
public static readonly examples = messages.getMessages('examples');
public static readonly requiresProject = true;
public static readonly deprecateAliases = true;
public static readonly aliases = ['force:package:list'];
public static readonly flags = {
loglevel,
'target-dev-hub': requiredHubFlag,
'api-version': orgApiVersionFlagWithDeprecations,
verbose: Flags.boolean({
summary: messages.getMessage('flags.verbose.summary'),
}),
};
private results: Package2Result[] = [];
public async run(): Promise<PackageListCommandResult> {
const { flags } = await this.parse(PackageListCommand);
const connection = flags['target-dev-hub'].getConnection(flags['api-version']);
const queryResult = await Package.list(connection);
this.mapRecordsToResults(queryResult);
this.displayResults(flags.verbose, connection.getApiVersion());
return this.results;
}
private mapRecordsToResults(records: PackagingSObjects.Package2[]): void {
if (records && records.length > 0) {
this.results = records
.filter((record) => record.IsDeprecated === false)
.map(
({
Id,
SubscriberPackageId,
Name,
Description,
NamespacePrefix,
ContainerOptions,
ConvertedFromPackageId,
IsOrgDependent,
PackageErrorUsername,
AppAnalyticsEnabled,
CreatedById,
}) =>
({
Id,
SubscriberPackageId,
Name,
Description,
NamespacePrefix,
ContainerOptions,
ConvertedFromPackageId,
Alias: this.project!.getAliasesFromPackageId(Id).join(),
IsOrgDependent: ContainerOptions === 'Managed' ? 'N/A' : IsOrgDependent ? 'Yes' : 'No',
PackageErrorUsername,
AppAnalyticsEnabled,
CreatedBy: CreatedById,
} as Package2Result)
);
}
}
private displayResults(verbose = false, apiVersion: string): void {
this.styledHeader(chalk.blue(`Packages [${this.results.length}]`));
const columns = {
NamespacePrefix: { header: messages.getMessage('namespace') },
Name: { header: messages.getMessage('name') },
Id: { header: messages.getMessage('id') },
Alias: { header: messages.getMessage('alias') },
Description: { header: messages.getMessage('description') },
ContainerOptions: {
header: messages.getMessage('package-type'),
},
};
if (verbose) {
Object.assign(columns, {
SubscriberPackageId: { header: messages.getMessage('package-id') },
ConvertedFromPackageId: { header: messages.getMessage('convertedFromPackageId') },
IsOrgDependent: { header: messages.getMessage('isOrgDependent') },
PackageErrorUsername: { header: messages.getMessage('error-notification-username') },
});
if (apiVersion >= '59.0') {
Object.assign(columns, {
AppAnalyticsEnabled: { header: messages.getMessage('app-analytics-enabled') },
});
}
Object.assign(columns, {
CreatedBy: {
header: messages.getMessage('createdBy'),
},
});
}
this.table(this.results, columns);
}
}