@pnp/cli-microsoft365 6.0.0-beta.d4d33ed → 6.0.0-beta.f305313

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.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/package.json

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