@pnp/cli-microsoft365 5.0.0-beta.ccc8737 → 5.0.0-beta.cdbc898

package/dist/m365/spo/commands/site/site-recyclebinitem-list.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+class SpoSiteRecycleBinItemListCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.SITE_RECYCLEBINITEM_LIST;
+    }
+    get description() {
+        return 'Lists items from recycle bin';
+    }
+    defaultProperties() {
+        return ['Id', 'Title', 'DirName'];
+    }
+    commandAction(logger, args, cb) {
+        if (this.verbose) {
+            logger.logToStderr(`Retrieving all items from recycle bin at ${args.options.siteUrl}...`);
+        }
+        const state = args.options.secondary ? '2' : '1';
+        let requestUrl = `${args.options.siteUrl}/_api/site/RecycleBin?$filter=(ItemState eq ${state})`;
+        if (typeof args.options.type !== 'undefined') {
+            const type = SpoSiteRecycleBinItemListCommand.recycleBinItemType.find(item => item.value === args.options.type);
+            if (typeof type !== 'undefined') {
+                requestUrl += ` and (ItemType eq ${type.id})`;
+            }
+        }
+        const requestOptions = {
+            url: requestUrl,
+            headers: {
+                'accept': 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        request_1.default
+            .get(requestOptions)
+            .then((response) => {
+            logger.log(response.value);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-u, --siteUrl <siteUrl>'
+            },
+            {
+                option: '-t, --type [type]',
+                autocomplete: SpoSiteRecycleBinItemListCommand.recycleBinItemType.map(item => item.value)
+            },
+            {
+                option: '-s, --secondary'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        const isValidSharePointUrl = SpoCommand_1.default.isValidSharePointUrl(args.options.siteUrl);
+        if (isValidSharePointUrl !== true) {
+            return isValidSharePointUrl;
+        }
+        if (typeof args.options.type !== 'undefined' &&
+            !SpoSiteRecycleBinItemListCommand.recycleBinItemType.some(item => item.value === args.options.type)) {
+            return `${args.options.type} is not a valid value. Allowed values are ${SpoSiteRecycleBinItemListCommand.recycleBinItemType.map(item => item.value).join(', ')}`;
+        }
+        return true;
+    }
+}
+SpoSiteRecycleBinItemListCommand.recycleBinItemType = [
+    { id: 1, value: 'files' },
+    { id: 3, value: 'listItems' },
+    { id: 5, value: 'folders' }
+];
+module.exports = new SpoSiteRecycleBinItemListCommand();
+//# sourceMappingURL=site-recyclebinitem-list.js.map

package/dist/m365/spo/commands.js

@@ -183,6 +183,7 @@ exports.default = {
     SITE_GROUPIFY: `${prefix} site groupify`,
     SITE_LIST: `${prefix} site list`,
     SITE_INPLACERECORDSMANAGEMENT_SET: `${prefix} site inplacerecordsmanagement set`,
+    SITE_RECYCLEBINITEM_LIST: `${prefix} site recyclebinitem list`,
     SITE_REMOVE: `${prefix} site remove`,
     SITE_RENAME: `${prefix} site rename`,
     SITE_SET: `${prefix} site set`,

package/docs/docs/cmd/spo/site/site-recyclebinitem-list.md

@@ -0,0 +1,40 @@
+# spo site recyclebinitem list
+
+Lists items from recycle bin
+
+## Usage
+
+```sh
+m365 spo site recyclebinitem list [options]
+```
+
+## Options
+
+`-u, --siteUrl <siteUrl>`
+: URL of the site for which to retrieve the recycle bin items
+
+`--type [type]`
+: Type of items which should be retrieved (listItems, folders, files)
+
+`--secondary`
+: Use this switch to retrieve items from secondary recycle bin
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+When type is not specified then the command will return all items in the recycle bin
+
+## Examples
+
+Lists all files, items and folders from recycle bin for site _https://contoso.sharepoint.com/site_
+
+```sh
+m365 spo site recyclebinitem list --siteUrl https://contoso.sharepoint.com/site
+```
+
+Lists only files from recycle bin for site _https://contoso.sharepoint.com/site_
+
+```sh
+m365 spo site recyclebinitem list --siteUrl https://contoso.sharepoint.com/site --type files
+```

package/package.json

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