Skip to content
Navigation Menu
{{ message }}
forked from pnp/cli-microsoft365
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCommand.ts
More file actions
341 lines (291 loc) · 9.49 KB
/
Copy pathCommand.ts
File metadata and controls
341 lines (291 loc) · 9.49 KB
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
import type * as Chalk from 'chalk';
import appInsights from './appInsights';
import auth from './Auth';
import { Cli } from './cli';
import { Logger } from './cli/Logger';
import GlobalOptions from './GlobalOptions';
import { GraphResponseError } from './m365/base/GraphResponseError';
import request from './request';
export interface CommandOption {
option: string;
autocomplete?: string[]
}
export interface CommandHelp {
(args: any, cbOrLog: (msg?: string) => void): void
}
export interface CommandTypes {
string?: string[];
boolean?: string[];
}
export class CommandError {
constructor(public message: string, public code?: number) {
}
}
export class CommandErrorWithOutput {
constructor(public error: CommandError, public stderr?: string) {
}
}
export interface ODataError {
"odata.error": {
code: string;
message: {
lang: string;
value: string;
}
}
}
export interface CommandArgs {
options: GlobalOptions;
}
export default abstract class Command {
protected _debug: boolean = false;
protected _verbose: boolean = false;
protected get debug(): boolean {
return this._debug;
}
protected get verbose(): boolean {
return this._verbose;
}
public abstract get name(): string;
public abstract get description(): string;
public abstract commandAction(logger: Logger, args: any, cb: () => void): void;
protected showDeprecationWarning(logger: Logger, deprecated: string, recommended: string): void {
const cli: Cli = Cli.getInstance();
if (cli.currentCommandName &&
cli.currentCommandName.indexOf(deprecated) === 0) {
const chalk: typeof Chalk = require('chalk');
logger.logToStderr(chalk.yellow(`Command '${deprecated}' is deprecated. Please use '${recommended}' instead`));
}
}
protected getUsedCommandName(): string {
const cli: Cli = Cli.getInstance();
const commandName: string = this.getCommandName();
if (!cli.currentCommandName) {
return commandName;
}
if (cli.currentCommandName &&
cli.currentCommandName.indexOf(commandName) === 0) {
return commandName;
}
// since the command was called by something else than its name
// it must have aliases
const aliases: string[] = this.alias() as string[];
for (let i: number = 0; i < aliases.length; i++) {
if (cli.currentCommandName.indexOf(aliases[i]) === 0) {
return aliases[i];
}
}
// shouldn't happen because the command is called either by its name or alias
return '';
}
public action(logger: Logger, args: CommandArgs, cb: (err?: any) => void): void {
auth
.restoreAuth()
.then((): void => {
this.initAction(args, logger);
if (!auth.service.connected) {
cb(new CommandError('Log in to Microsoft 365 first'));
return;
}
this.commandAction(logger, args, cb);
}, (error: any): void => {
cb(new CommandError(error));
});
}
public getTelemetryProperties(args: any): any {
return {
debug: this.debug.toString(),
verbose: this.verbose.toString(),
output: args.options.output,
query: typeof args.options.query !== 'undefined'
};
}
public alias(): string[] | undefined {
return;
}
public autocomplete(): string[] | undefined {
return;
}
/**
* Returns list of properties that should be returned in the text output.
* Returns all properties if no default properties specified
*/
public defaultProperties(): string[] | undefined {
return;
}
public allowUnknownOptions(): boolean | undefined {
return;
}
public options(): CommandOption[] {
return [
{
option: '--query [query]'
},
{
option: '-o, --output [output]',
autocomplete: ['json', 'text']
},
{
option: '--verbose'
},
{
option: '--debug'
}
];
}
// eslint-disable-next-line @typescript-eslint/no-unused-vars
public validate(args: any): boolean | string {
return true;
}
public types(): CommandTypes | undefined {
return;
}
/**
* Processes options after resolving them from the user input and before
* passing them on to command action for execution. Used for example for
* expanding server-relative URLs to absolute in spo commands
* @param options Object that contains command's options
*/
// eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-empty-function
public async processOptions(options: any): Promise<void> {
}
public getCommandName(): string {
let commandName: string = this.name;
let pos: number = commandName.indexOf('<');
const pos1: number = commandName.indexOf('[');
if (pos > -1 || pos1 > -1) {
if (pos1 > -1) {
pos = pos1;
}
commandName = commandName.substr(0, pos).trim();
}
return commandName;
}
protected handleRejectedODataPromise(rawResponse: any, logger: Logger, callback: (err?: any) => void): void {
const res: any = JSON.parse(JSON.stringify(rawResponse));
if (res.error) {
try {
const err: ODataError = JSON.parse(res.error);
callback(new CommandError(err['odata.error'].message.value));
}
catch {
try {
const graphResponseError: GraphResponseError = res.error;
if (graphResponseError.error.code) {
callback(new CommandError(graphResponseError.error.code + " - " + graphResponseError.error.message));
}
else {
callback(new CommandError(graphResponseError.error.message));
}
}
catch {
callback(new CommandError(res.error));
}
}
}
else {
if (rawResponse instanceof Error) {
callback(new CommandError(rawResponse.message));
}
else {
callback(new CommandError(rawResponse));
}
}
}
protected handleRejectedODataJsonPromise(response: any, logger: Logger, callback: (err?: any) => void): void {
// console.log(JSON.stringify(response, null, 2));
if (response.error &&
response.error['odata.error'] &&
response.error['odata.error'].message) {
return callback(new CommandError(response.error['odata.error'].message.value));
}
if (!response.error) {
if (response instanceof Error) {
return callback(new CommandError(response.message));
}
else {
return callback(new CommandError(response));
}
}
if (response.error.error &&
response.error.error.message) {
return callback(new CommandError(response.error.error.message));
}
if (response.error.message) {
return callback(new CommandError(response.error.message));
}
if (response.error.error_description) {
return callback(new CommandError(response.error.error_description));
}
try {
const error: any = JSON.parse(response.error);
if (error &&
error.error &&
error.error.message) {
callback(new CommandError(error.error.message));
}
else {
callback(new CommandError(response.error));
}
}
catch {
callback(new CommandError(response.error));
}
}
protected handleError(rawResponse: any, logger: Logger, callback: (err?: any) => void): void {
if (rawResponse instanceof Error) {
callback(new CommandError(rawResponse.message));
}
else {
callback(new CommandError(rawResponse));
}
}
protected handleRejectedPromise(rawResponse: any, logger: Logger, callback: (err?: any) => void): void {
this.handleError(rawResponse, logger, callback);
}
protected initAction(args: CommandArgs, logger: Logger): void {
this._debug = args.options.debug || process.env.CLIMICROSOFT365_DEBUG === '1';
this._verbose = this._debug || args.options.verbose || process.env.CLIMICROSOFT365_VERBOSE === '1';
request.debug = this._debug;
request.logger = logger;
appInsights.trackEvent({
name: this.getUsedCommandName(),
properties: this.getTelemetryProperties(args)
});
appInsights.flush();
}
protected getUnknownOptions(options: any): any {
const unknownOptions: any = JSON.parse(JSON.stringify(options));
// remove minimist catch-all option
delete unknownOptions._;
const knownOptions: CommandOption[] = this.options();
const longOptionRegex: RegExp = /--([^\s]+)/;
const shortOptionRegex: RegExp = /-([a-z])\b/;
knownOptions.forEach(o => {
const longOptionName: string = (longOptionRegex.exec(o.option) as RegExpExecArray)[1];
delete unknownOptions[longOptionName];
// short names are optional so we need to check if the current command has
// one before continuing
const shortOptionMatch: RegExpExecArray | null = shortOptionRegex.exec(o.option);
if (shortOptionMatch) {
const shortOptionName: string = shortOptionMatch[1];
delete unknownOptions[shortOptionName];
}
});
return unknownOptions;
}
protected trackUnknownOptions(telemetryProps: any, options: any): void {
const unknownOptions: any = this.getUnknownOptions(options);
const unknownOptionsNames: string[] = Object.getOwnPropertyNames(unknownOptions);
unknownOptionsNames.forEach(o => {
telemetryProps[o] = true;
});
}
protected addUnknownOptionsToPayload(payload: any, options: any): void {
const unknownOptions: any = this.getUnknownOptions(options);
const unknownOptionsNames: string[] = Object.getOwnPropertyNames(unknownOptions);
unknownOptionsNames.forEach(o => {
payload[o] = unknownOptions[o];
});
}
}
You can’t perform that action at this time.