@pnp/cli-microsoft365 5.1.0-beta.c27e2b5 → 5.1.0-beta.c518929

package/.eslintrc.js

@@ -59,6 +59,7 @@ const dictionary = [
   'site',
   'status',
   'storage',
+  'teams',
   'token',
   'type',
   'user',

package/Dockerfile

@@ -21,7 +21,9 @@ RUN apk add --no-cache \
   shadow \
   bash-completion \
   nodejs \
-  npm
+  npm \
+  python3 \
+  py3-pip
 
 RUN adduser --system cli-microsoft365
 USER cli-microsoft365
@@ -31,11 +33,10 @@ WORKDIR /home/cli-microsoft365
 ENV 0="/bin/bash" \
   SHELL="bash" \
   NPM_CONFIG_PREFIX=/home/cli-microsoft365/.npm-global \
-  PATH=$PATH:/home/cli-microsoft365/.npm-global/bin \
+  PATH=$PATH:/home/cli-microsoft365/.npm-global/bin:/home/cli-microsoft365/.local/bin \
   CLIMICROSOFT365_ENV="docker"
 
-RUN bash -c 'echo "export PATH=$PATH:/home/cli-microsoft365/.npm-global/bin" >> ~/.bash_profile' \
-  && bash -c 'echo "export NPM_CONFIG_PREFIX=/home/cli-microsoft365/.npm-global" >> ~/.bash_profile' \
+RUN bash -c 'echo "export PATH=$PATH:/home/cli-microsoft365/.npm-global/bin:/home/.local/bin" >> ~/.bash_profile' \
   && bash -c 'echo "export CLIMICROSOFT365_ENV=\"docker\"" >> ~/.bash_profile' \
   && bash -c 'npm i -g @pnp/cli-microsoft365@${CLI_VERSION} --production --quiet --no-progress' \ 
   && bash -c 'echo "source /etc/profile.d/bash_completion.sh" >> ~/.bash_profile' \
@@ -43,4 +44,6 @@ RUN bash -c 'echo "export PATH=$PATH:/home/cli-microsoft365/.npm-global/bin" >>
   && bash -c 'm365 cli completion sh setup' \
   && pwsh -c 'm365 cli completion pwsh setup --profile $profile'
 
+RUN pip install jmespath-terminal
+
 CMD [ "bash", "-l" ]

package/dist/Command.js

@@ -123,6 +123,9 @@ class Command {
             }
         ];
     }
+    optionSets() {
+        return;
+    }
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     validate(args) {
         return true;

package/dist/cli/Cli.js

@@ -163,6 +163,19 @@ class Cli {
             if (optionsWithoutShorts.options.output === undefined) {
                 optionsWithoutShorts.options.output = this.getSettingWithDefaultValue(settingsNames_1.settingsNames.output, undefined);
             }
+            // validate options sets defined by the command
+            const optionsSets = this.commandToExecute.command.optionSets();
+            const argsOptions = Object.keys(this.optionsFromArgs.options);
+            const cmdArgs = this.optionsFromArgs;
+            optionsSets === null || optionsSets === void 0 ? void 0 : optionsSets.forEach((optionSet) => {
+                const commonOptions = argsOptions.filter(opt => optionSet.includes(opt));
+                if (commonOptions.length === 0) {
+                    return this.closeWithError(`Specify one of the following options: ${optionSet.map(opt => opt).join(', ')}.`, cmdArgs, true);
+                }
+                if (commonOptions.length > 1) {
+                    return this.closeWithError(`Specify one of the following options: ${optionSet.map(opt => opt).join(', ')}, but not multiple.`, cmdArgs, true);
+                }
+            });
             const validationResult = this.commandToExecute.command.validate(optionsWithoutShorts);
             if (typeof validationResult === 'string') {
                 return this.closeWithError(validationResult, optionsWithoutShorts, true);

package/dist/m365/spfx/commands/spfx-doctor.js

@@ -481,6 +481,9 @@ class SpfxDoctorCommand extends AnonymousCommand_1.default {
         return 'Verifies environment configuration for using the specific version of the SharePoint Framework';
     }
     commandAction(logger, args, cb) {
+        if (!args.options.output) {
+            args.options.output = 'text';
+        }
         logger.log(' ');
         logger.log('CLI for Microsoft 365 SharePoint Framework doctor');
         logger.log('Verifying configuration of your system for working with the SharePoint Framework');
@@ -758,6 +761,9 @@ class SpfxDoctorCommand extends AnonymousCommand_1.default {
                 return `${args.options.env} is not a valid SharePoint version. Valid versions are sp2016, sp2019 or spo`;
             }
         }
+        if (args.options.output && args.options.output !== 'text') {
+            return `The output option only accepts the type 'text'`;
+        }
         return true;
     }
 }

package/dist/m365/spo/commands/app/app-teamspackage-download.js

@@ -0,0 +1,180 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs");
+const path = require("path");
+const request_1 = require("../../../../request");
+const urlUtil_1 = require("../../../../utils/urlUtil");
+const spo_1 = require("../../../../utils/spo");
+const validation_1 = require("../../../../utils/validation");
+const commands_1 = require("../../commands");
+const SpoAppBaseCommand_1 = require("./SpoAppBaseCommand");
+class SpoAppTeamsPackageDownloadCommand extends SpoAppBaseCommand_1.SpoAppBaseCommand {
+    get name() {
+        return commands_1.default.APP_TEAMSPACKAGE_DOWNLOAD;
+    }
+    get description() {
+        return 'Downloads Teams app package for an SPFx solution deployed to tenant app catalog';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.appCatalogUrl = typeof args.options.appCatalogUrl !== 'undefined';
+        telemetryProps.appItemUniqueId = typeof args.options.appItemUniqueId !== 'undefined';
+        telemetryProps.appItemId = typeof args.options.appItemId !== 'undefined';
+        telemetryProps.appName = typeof args.options.appName !== 'undefined';
+        telemetryProps.fileName = typeof args.options.fileName !== 'undefined';
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        var _a, _b;
+        this.appCatalogUrl = args.options.appCatalogUrl;
+        const appInfo = {
+            id: (_a = args.options.appItemId) !== null && _a !== void 0 ? _a : undefined,
+            packageFileName: (_b = args.options.fileName) !== null && _b !== void 0 ? _b : undefined
+        };
+        if (this.debug) {
+            logger.logToStderr(`appInfo: ${JSON.stringify(appInfo)}`);
+        }
+        this
+            .ensureAppInfo(logger, args, appInfo)
+            .then(_ => {
+            if (this.debug) {
+                logger.logToStderr(`ensureAppInfo: ${JSON.stringify(appInfo)}`);
+            }
+            return this.loadAppCatalogUrl(logger, args);
+        })
+            .then(_ => {
+            const requestOptions = {
+                url: `${this.appCatalogUrl}/_api/web/tenantappcatalog/downloadteamssolution(${appInfo.id})/$value`,
+                headers: {
+                    accept: 'application/json;odata=nometadata'
+                },
+                responseType: 'stream'
+            };
+            return request_1.default.get(requestOptions);
+        })
+            .then((file) => {
+            return new Promise((resolve, reject) => {
+                const writer = fs.createWriteStream(appInfo.packageFileName);
+                file.data.pipe(writer);
+                writer.on('error', err => {
+                    reject(err);
+                });
+                writer.on('close', () => {
+                    resolve(appInfo.packageFileName);
+                });
+            });
+        })
+            .then((file) => {
+            if (this.verbose) {
+                logger.logToStderr(`Package saved to ${file}`);
+            }
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    ensureAppInfo(logger, args, appInfo) {
+        if (appInfo.id && appInfo.packageFileName) {
+            return Promise.resolve();
+        }
+        if (args.options.appName && !appInfo.packageFileName) {
+            appInfo.packageFileName = this.getPackageNameFromFileName(args.options.appName);
+        }
+        return this
+            .loadAppCatalogUrl(logger, args)
+            .then(_ => {
+            const appCatalogListName = 'AppCatalog';
+            const serverRelativeAppCatalogListUrl = `${urlUtil_1.urlUtil.getServerRelativeSiteUrl(this.appCatalogUrl)}/${appCatalogListName}`;
+            let url = `${this.appCatalogUrl}/_api/web/`;
+            if (args.options.appItemUniqueId) {
+                url += `GetList('${serverRelativeAppCatalogListUrl}')/GetItemByUniqueId('${args.options.appItemUniqueId}')?$expand=File&$select=Id,File/Name`;
+            }
+            else if (args.options.appItemId) {
+                url += `GetList('${serverRelativeAppCatalogListUrl}')/GetItemById(${args.options.appItemId})?$expand=File&$select=File/Name`;
+            }
+            else if (args.options.appName) {
+                url += `getfolderbyserverrelativeurl('${appCatalogListName}')/files('${encodeURIComponent(args.options.appName)}')/ListItemAllFields?$select=Id`;
+            }
+            const requestOptions = {
+                url,
+                headers: {
+                    accept: 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.get(requestOptions);
+        })
+            .then(res => {
+            if (args.options.appItemUniqueId) {
+                appInfo.id = parseInt(res.Id);
+                if (!appInfo.packageFileName) {
+                    appInfo.packageFileName = this.getPackageNameFromFileName(res.File.Name);
+                }
+                return Promise.resolve();
+            }
+            if (args.options.appItemId) {
+                if (!appInfo.packageFileName) {
+                    appInfo.packageFileName = this.getPackageNameFromFileName(res.File.Name);
+                }
+                return Promise.resolve();
+            }
+            // if (args.options.appName)
+            // skipped 'if' clause to provide a default code branch
+            appInfo.id = parseInt(res.Id);
+            return Promise.resolve();
+        });
+    }
+    getPackageNameFromFileName(fileName) {
+        return `${path.basename(fileName, path.extname(fileName))}.zip`;
+    }
+    loadAppCatalogUrl(logger, args) {
+        if (this.appCatalogUrl) {
+            return Promise.resolve();
+        }
+        return spo_1.spo
+            .getSpoUrl(logger, this.debug)
+            .then(spoUrl => this.getAppCatalogSiteUrl(logger, spoUrl, args))
+            .then(appCatalogUrl => {
+            this.appCatalogUrl = appCatalogUrl;
+        });
+    }
+    options() {
+        const options = [
+            { option: '--appItemId [appItemId]' },
+            { option: '--appItemUniqueId [appItemUniqueId]' },
+            { option: '--appName [appName]' },
+            { option: '--fileName [fileName]' },
+            { option: '-u, --appCatalogUrl [appCatalogUrl]' }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (!args.options.appItemUniqueId &&
+            !args.options.appItemId &&
+            !args.options.appName) {
+            return `Specify appItemUniqueId, appItemId or appName`;
+        }
+        if ((args.options.appItemUniqueId && args.options.appItemId) ||
+            (args.options.appItemUniqueId && args.options.appName) ||
+            (args.options.appItemId && args.options.appName)) {
+            return `Specify appItemUniqueId, appItemId or appName but not multiple`;
+        }
+        if (args.options.appItemUniqueId &&
+            !validation_1.validation.isValidGuid(args.options.appItemUniqueId)) {
+            return `${args.options.appItemUniqueId} is not a valid GUID`;
+        }
+        if (args.options.appItemId &&
+            isNaN(args.options.appItemId)) {
+            return `${args.options.appItemId} is not a number`;
+        }
+        if (args.options.fileName &&
+            fs.existsSync(args.options.fileName)) {
+            return `File ${args.options.fileName} already exists`;
+        }
+        if (args.options.appCatalogUrl) {
+            return validation_1.validation.isValidSharePointUrl(args.options.appCatalogUrl);
+        }
+        return true;
+    }
+}
+module.exports = new SpoAppTeamsPackageDownloadCommand();
+//# sourceMappingURL=app-teamspackage-download.js.map

package/dist/m365/spo/commands.js

@@ -10,6 +10,7 @@ exports.default = {
     APP_LIST: `${prefix} app list`,
     APP_REMOVE: `${prefix} app remove`,
     APP_RETRACT: `${prefix} app retract`,
+    APP_TEAMSPACKAGE_DOWNLOAD: `${prefix} app teamspackage download`,
     APP_UNINSTALL: `${prefix} app uninstall`,
     APP_UPGRADE: `${prefix} app upgrade`,
     APPPAGE_ADD: `${prefix} apppage add`,

package/docs/docs/cmd/spfx/spfx-doctor.md

@@ -20,7 +20,7 @@ m365 spfx doctor [options]
 : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
 
 `-o, --output [output]`
-: Output type. `json,text,csv,md`. Default `json`
+: Output type. `text`. Default `text`
 
 `--verbose`
 : Runs command with verbose logging
@@ -43,6 +43,9 @@ If you miss any required tools or use a version that doesn't meet the SharePoint
 
 Next to verifying the readiness of your environment to use a particular version of the SharePoint Framework, you can also check if the version of the SharePoint Framework that you use is compatible with the specific version of SharePoint. Supported versions are `sp2016`, `sp2019` and `spo`.
 
+!!! important
+    This command supports only text output.
+
 ## Examples
 
 Verify if your environment meets the requirements to work with the SharePoint Framework

package/docs/docs/cmd/spo/app/app-teamspackage-download.md

@@ -0,0 +1,56 @@
+# spo app teamspackage download
+
+Downloads Teams app package for an SPFx solution deployed to tenant app catalog
+
+## Usage
+
+```sh
+m365 spo app teamspackage download [options]
+```
+
+## Options
+
+`--appItemUniqueId [appItemUniqueId]`
+: The unique ID of the SPFx app to download the Teams package for. Specify `appItemUniqueId`, `appItemId` or `appName`
+
+`--appItemId [appItemId]`
+: The ID of the list item behind the SPFx app to download the Teams package for. Specify `appItemUniqueId`, `appItemId` or `appName`
+
+`--appName [appName]`
+: The name of the sppkg file to download the Teams package for. Specify `appItemUniqueId`, `appItemId` or `appName`
+
+`--fileName [fileName]`
+: Name of the file to save the package to. If not specified will use the name of the sppkg file with a `.zip` extension
+
+`-u, --appCatalogUrl [appCatalogUrl]`
+: URL of the tenant app catalog. If not specified, the command will try to autodiscover it
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+Download the Teams app package for an SPFx solution works only for solutions deployed to the tenant app catalog.
+
+If you try to download Teams app package for an SPFx solution that doesn't support deployment to Teams, you'll get the _Request failed with status code 404_ error.
+
+For maximum performance, specify the URL of the tenant app catalog, the item ID (`appItemId`) of the SPFx package for which you want to download the Teams app package and the name of the file where you want to save the downloaded package to (`fileName`).
+
+## Examples
+
+Downloads the Teams app package for the SPFx solution deployed to the tenant app catalog with the ID `1` to a file with .zip extension named after the .sppkg file:
+
+```sh
+m365 spo app teamspackage download --appItemId 1
+```
+
+Downloads the Teams app package for the SPFx solution deployed to the tenant app catalog with the unique item ID `335a5612-3e85-462d-9d5b-c014b5abeac5` to the specified file:
+
+```sh
+m365 spo app teamspackage download --appItemUniqueId 335a5612-3e85-462d-9d5b-c014b5abeac5 --fileName my-app.zip
+```
+
+Downloads the Teams app package for the SPFx solution deployed to the specified tenant app catalog:
+
+```sh
+m365 spo app teamspackage download --appName my-app.sppkg --appCatalogUrl https://contoso.sharepoint.com/sites/appcatalog
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "5.1.0-beta.c27e2b5",
+  "version": "5.1.0-beta.c518929",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",