@pnp/cli-microsoft365 5.5.0 → 5.6.0-beta.8b9dde0

package/dist/m365/spo/commands/file/file-rename.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_1 = require("../../../../cli");
+const request_1 = require("../../../../request");
+const utils_1 = require("../../../../utils");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+const removeCommand = require('./file-remove');
+class SpoFileRenameCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.FILE_RENAME;
+    }
+    get description() {
+        return 'Renames a file';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.force = !!args.options.force;
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        const webUrl = args.options.webUrl;
+        const originalFileServerRelativeUrl = utils_1.urlUtil.getServerRelativePath(args.options.webUrl, args.options.sourceUrl);
+        this
+            .getFile(originalFileServerRelativeUrl, webUrl)
+            .then((_) => {
+            if (args.options.force) {
+                return this.deleteFile(webUrl, args.options.sourceUrl, args.options.targetFileName);
+            }
+            return Promise.resolve();
+        })
+            .then(_ => {
+            const requestBody = {
+                formValues: [{
+                        FieldName: 'FileLeafRef',
+                        FieldValue: args.options.targetFileName
+                    }]
+            };
+            const requestOptions = {
+                url: `${webUrl}/_api/web/GetFileByServerRelativeUrl('${encodeURIComponent(originalFileServerRelativeUrl)}')/ListItemAllFields/ValidateUpdateListItem()`,
+                headers: {
+                    'accept': 'application/json;odata=nometadata'
+                },
+                data: requestBody,
+                responseType: 'json'
+            };
+            return request_1.default.post(requestOptions);
+        })
+            .then((resp) => {
+            logger.log(resp.value);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    getFile(originalFileServerRelativeUrl, webUrl) {
+        const requestUrl = `${webUrl}/_api/web/GetFileByServerRelativeUrl('${encodeURIComponent(originalFileServerRelativeUrl)}')?$select=UniqueId`;
+        const requestOptions = {
+            url: requestUrl,
+            headers: {
+                'accept': 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        return request_1.default.get(requestOptions);
+    }
+    deleteFile(webUrl, sourceUrl, targetFileName) {
+        const targetFileServerRelativeUrl = `${utils_1.urlUtil.getServerRelativePath(webUrl, sourceUrl.substring(0, sourceUrl.lastIndexOf('/')))}/${targetFileName}`;
+        const options = {
+            webUrl: webUrl,
+            url: targetFileServerRelativeUrl,
+            recycle: true,
+            confirm: true,
+            debug: this.debug,
+            verbose: this.verbose
+        };
+        return cli_1.Cli.executeCommandWithOutput(removeCommand, { options: Object.assign(Object.assign({}, options), { _: [] }) })
+            .then(_ => {
+            return Promise.resolve();
+        }, (err) => {
+            if (err.error !== null && err.error.message !== null && err.error.message.includes('does not exist')) {
+                return Promise.resolve();
+            }
+            return Promise.reject(err);
+        });
+    }
+    options() {
+        const options = [
+            {
+                option: '-u, --webUrl <webUrl>'
+            },
+            {
+                option: '-s, --sourceUrl <sourceUrl>'
+            },
+            {
+                option: '-t, --targetFileName <targetFileName>'
+            },
+            {
+                option: '--force'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        return utils_1.validation.isValidSharePointUrl(args.options.webUrl);
+    }
+}
+module.exports = new SpoFileRenameCommand();
+//# sourceMappingURL=file-rename.js.map

package/dist/m365/spo/commands/group/group-get.js

@@ -15,6 +15,7 @@ class SpoGroupGetCommand extends SpoCommand_1.default {
         const telemetryProps = super.getTelemetryProperties(args);
         telemetryProps.id = (!(!args.options.id)).toString();
         telemetryProps.name = (!(!args.options.name)).toString();
+        telemetryProps.associatedGroup = args.options.associatedGroup;
         return telemetryProps;
     }
     commandAction(logger, args, cb) {
@@ -28,6 +29,19 @@ class SpoGroupGetCommand extends SpoCommand_1.default {
         else if (args.options.name) {
             requestUrl = `${args.options.webUrl}/_api/web/sitegroups/GetByName('${encodeURIComponent(args.options.name)}')`;
         }
+        else if (args.options.associatedGroup) {
+            switch (args.options.associatedGroup.toLowerCase()) {
+                case 'owner':
+                    requestUrl = `${args.options.webUrl}/_api/web/AssociatedOwnerGroup`;
+                    break;
+                case 'member':
+                    requestUrl = `${args.options.webUrl}/_api/web/AssociatedMemberGroup`;
+                    break;
+                case 'visitor':
+                    requestUrl = `${args.options.webUrl}/_api/web/AssociatedVisitorGroup`;
+                    break;
+            }
+        }
         const requestOptions = {
             url: requestUrl,
             method: 'GET',
@@ -53,21 +67,27 @@ class SpoGroupGetCommand extends SpoCommand_1.default {
             },
             {
                 option: '--name [name]'
+            },
+            {
+                option: '--associatedGroup [associatedGroup]',
+                autocomplete: ['Owner', 'Member', 'Visitor']
             }
         ];
         const parentOptions = super.options();
         return options.concat(parentOptions);
     }
+    optionSets() {
+        return [
+            ['id', 'name', 'associatedGroup']
+        ];
+    }
     validate(args) {
-        if (args.options.id && args.options.name) {
-            return 'Use either "id" or "name", but not all.';
-        }
-        if (!args.options.id && !args.options.name) {
-            return 'Specify id or name, one is required';
-        }
         if (args.options.id && isNaN(args.options.id)) {
             return `Specified id ${args.options.id} is not a number`;
         }
+        if (args.options.associatedGroup && ['owner', 'member', 'visitor'].indexOf(args.options.associatedGroup.toLowerCase()) === -1) {
+            return `${args.options.associatedGroup} is not a valid associatedGroup value. Allowed values are Owner|Member|Visitor.`;
+        }
         return utils_1.validation.isValidSharePointUrl(args.options.webUrl);
     }
 }

package/dist/m365/spo/commands/site/site-apppermission-add.js

@@ -73,7 +73,7 @@ class SpoSiteAppPermissionAddCommand extends GraphCommand_1.default {
     }
     mapRequestBody(permission, appInfo) {
         const requestBody = {
-            roles: permission.split(',')
+            roles: [permission]
         };
         requestBody.grantedToIdentities = [];
         requestBody.grantedToIdentities.push({ application: { "id": appInfo.appId, "displayName": appInfo.displayName } });
@@ -129,11 +129,8 @@ class SpoSiteAppPermissionAddCommand extends GraphCommand_1.default {
         if (args.options.appId && !utils_1.validation.isValidGuid(args.options.appId)) {
             return `${args.options.appId} is not a valid GUID`;
         }
-        const permissions = args.options.permission.split(',');
-        for (let i = 0; i < permissions.length; i++) {
-            if (['read', 'write'].indexOf(permissions[i]) === -1) {
-                return `${permissions[i]} is not a valid permission value. Allowed values read|write|read,write`;
-            }
+        if (['read', 'write', 'owner'].indexOf(args.options.permission) === -1) {
+            return `${args.options.permission} is not a valid permission value. Allowed values are read|write|owner`;
         }
         return utils_1.validation.isValidSharePointUrl(args.options.siteUrl);
     }

package/dist/m365/spo/commands/site/site-apppermission-set.js

@@ -83,7 +83,7 @@ class SpoSiteAppPermissionSetCommand extends GraphCommand_1.default {
                     'content-type': 'application/json;odata=nometadata'
                 },
                 data: {
-                    roles: args.options.permission.split(',')
+                    roles: [args.options.permission]
                 },
                 responseType: 'json'
             };
@@ -122,11 +122,8 @@ class SpoSiteAppPermissionSetCommand extends GraphCommand_1.default {
         if (args.options.appId && !utils_1.validation.isValidGuid(args.options.appId)) {
             return `${args.options.appId} is not a valid GUID`;
         }
-        const permissions = args.options.permission.split(',');
-        for (let i = 0; i < permissions.length; i++) {
-            if (['read', 'write'].indexOf(permissions[i]) === -1) {
-                return `${permissions[i]} is not a valid permission value. Allowed values are read|write|read,write`;
-            }
+        if (['read', 'write', 'owner'].indexOf(args.options.permission) === -1) {
+            return `${args.options.permission} is not a valid permission value. Allowed values are read|write|owner`;
         }
         return utils_1.validation.isValidSharePointUrl(args.options.siteUrl);
     }

package/dist/m365/spo/commands.js

@@ -54,6 +54,7 @@ exports.default = {
     FILE_LIST: `${prefix} file list`,
     FILE_MOVE: `${prefix} file move`,
     FILE_REMOVE: `${prefix} file remove`,
+    FILE_RENAME: `${prefix} file rename`,
     FILE_SHARINGINFO_GET: `${prefix} file sharinginfo get`,
     FOLDER_ADD: `${prefix} folder add`,
     FOLDER_COPY: `${prefix} folder copy`,

package/docs/docs/cmd/spo/file/file-rename.md

@@ -0,0 +1,43 @@
+# spo file rename
+
+Renames a file
+
+## Usage
+
+```sh
+m365 spo file rename [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: The URL of the site where the file is located
+
+`-s, --sourceUrl <sourceUrl>`
+: Site-relative URL of the file to rename
+
+`-t, --targetFileName <targetFileName>`
+: New file name of the file
+
+`--force`
+: If a file already exists with target file name, it will be moved to the recycle bin. If omitted, the rename operation will be canceled if a file already exists with the specified file name
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+If you try to rename a file without the `--force` flag and a file with this name already exists, the operation will be cancelled.
+
+## Examples
+
+Renames a file with server-relative URL _/Shared Documents/Test1.docx_ located in site _<https://contoso.sharepoint.com/sites/project-x>_ to _Test2.docx_
+
+```sh
+m365 spo file rename --webUrl https://contoso.sharepoint.com/sites/project-x --sourceUrl '/Shared Documents/Test1.docx' --targetFileName 'Test2.docx'
+```
+
+Renames a file with server-relative URL _/Shared Documents/Test1.docx_ located in site _<https://contoso.sharepoint.com/sites/project-x>_ to _Test2.docx_. If the file with the target file name already exists, this file will be moved to the recycle bin
+
+```sh
+m365 spo file rename --webUrl https://contoso.sharepoint.com/sites/project-x --sourceUrl '/Shared Documents/Test1.docx' --targetFileName 'Test2.docx' --force
+```

package/docs/docs/cmd/spo/group/group-get.md

@@ -11,13 +11,16 @@ m365 spo group get [options]
 ## Options
 
 `-u, --webUrl <webUrl>`
-: URL of the site where the group is located
+: URL of the site where the group is located.
 
 `-i, --id [id]`
-: ID of the site group to get. Use either `id` or `name`, but not all. e.g `7`
+: ID of the site group to get. Use either `id`, `name` or `associatedGroup` but not multiple.
 
 `--name [name]`
-: Name of the site group to get. Specify either `id` or `name` but not both e.g `Team Site Members`
+: Name of the site group to get. Use either `id`, `name` or `associatedGroup` but not multiple.
+
+`--associatedGroup [associatedGroup]`
+: Type of the associated group to get. Available values: `Owner`, `Member`, `Visitor`. Use either `id`, `name` or `associatedGroup` but not multiple.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -34,3 +37,9 @@ Get group with name _Team Site Members_ for web _https://contoso.sharepoint.com/
 ```sh
 m365 spo group get --webUrl https://contoso.sharepoint.com/sites/project-x --name "Team Site Members"
 ```
+
+Get the associated owner group of a specified site
+
+```sh
+m365 spo group get --webUrl https://contoso.sharepoint.com/sites/project-x --associatedGroup Owner
+```

package/docs/docs/cmd/spo/site/site-apppermission-add.md

@@ -14,7 +14,7 @@ m365 spo site apppermission add [options]
 : URL of the site collection to add the permission
 
 `-p, --permission <permission>`
-: Permission to site (`read`, `write`, `read,write`). If multiple permissions have to be granted, they have to be comma separated ex. `read,write`
+: Permission to site (`read`, `write`, or `owner`)
 
 `-i, --appId [appId]`
 : Client ID of the Azure AD app for which to grant permissions

package/docs/docs/cmd/spo/site/site-apppermission-set.md

@@ -23,7 +23,7 @@ m365 spo site apppermission set [options]
 : Display name of the Azure AD app for which to update permissions. Specify `permissionId`, `appId` or `appDisplayName`
 
 `-p, --permission <permission>`
-: Permission to site (`read`, `write`, `read,write`). If multiple permissions have to be granted, they have to be comma separated ex. `read,write`
+: Permission to site (`read`, `write`, or `owner`)
 
 --8<-- "docs/cmd/_global.md"
 

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "5.5.0",
+  "version": "5.6.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@pnp/cli-microsoft365",
-      "version": "5.5.0",
+      "version": "5.6.0",
       "license": "MIT",
       "dependencies": {
         "@azure/msal-node": "^1.11.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "5.5.0",
+  "version": "5.6.0-beta.8b9dde0",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",
@@ -239,4 +239,4 @@
     "sinon": "^14.0.0",
     "source-map-support": "^0.5.21"
   }
-}
+}