@pnp/cli-microsoft365 5.3.0-beta.b46b892 → 5.3.0-beta.d2ec1f4

package/dist/m365/spo/commands/field/field-list.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const utils_1 = require("../../../../utils");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+class SpoFieldListCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.FIELD_LIST;
+    }
+    get description() {
+        return 'Retrieves columns for the specified list or site';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.listId = typeof args.options.listId !== 'undefined';
+        telemetryProps.listTitle = typeof args.options.listTitle !== 'undefined';
+        telemetryProps.listUrl = typeof args.options.listUrl !== 'undefined';
+        return telemetryProps;
+    }
+    defaultProperties() {
+        return ['Id', 'Title', 'Group', 'Hidden'];
+    }
+    commandAction(logger, args, cb) {
+        let listUrl = '';
+        if (args.options.listId) {
+            listUrl = `lists(guid'${encodeURIComponent(args.options.listId)}')/`;
+        }
+        else if (args.options.listTitle) {
+            listUrl = `lists/getByTitle('${encodeURIComponent(args.options.listTitle)}')/`;
+        }
+        else if (args.options.listUrl) {
+            const listServerRelativeUrl = utils_1.urlUtil.getServerRelativePath(args.options.webUrl, args.options.listUrl);
+            listUrl = `GetList('${encodeURIComponent(listServerRelativeUrl)}')/`;
+        }
+        const requestOptions = {
+            url: `${args.options.webUrl}/_api/web/${listUrl}fields`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        request_1.default
+            .get(requestOptions)
+            .then((res) => {
+            logger.log(res.value);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-u, --webUrl <webUrl>'
+            },
+            {
+                option: '-t, --listTitle [listTitle]'
+            },
+            {
+                option: '-i, --listId [listId]'
+            },
+            {
+                option: '--listUrl [listUrl]'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        const isValidSharePointUrl = utils_1.validation.isValidSharePointUrl(args.options.webUrl);
+        if (isValidSharePointUrl !== true) {
+            return isValidSharePointUrl;
+        }
+        if (args.options.listId && !utils_1.validation.isValidGuid(args.options.listId)) {
+            return `${args.options.listId} is not a valid GUID`;
+        }
+        const listOptions = [args.options.listId, args.options.listTitle, args.options.listUrl];
+        if (listOptions.some(item => item !== undefined) && listOptions.filter(item => item !== undefined).length > 1) {
+            return `Specify either list id or title or list url`;
+        }
+        return true;
+    }
+}
+module.exports = new SpoFieldListCommand();
+//# sourceMappingURL=field-list.js.map

package/dist/m365/spo/commands.js

@@ -41,6 +41,7 @@ exports.default = {
     FEATURE_LIST: `${prefix} feature list`,
     FIELD_ADD: `${prefix} field add`,
     FIELD_GET: `${prefix} field get`,
+    FIELD_LIST: `${prefix} field list`,
     FIELD_REMOVE: `${prefix} field remove`,
     FIELD_SET: `${prefix} field set`,
     FILE_ADD: `${prefix} file add`,

package/docs/docs/cmd/spo/field/field-list.md

@@ -0,0 +1,51 @@
+# spo field list
+
+Retrieves columns for the specified list or site
+
+## Usage
+
+```sh
+m365 spo field list [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: Absolute URL of the site where fields are located
+
+`-t, --listTitle [listTitle]`
+: Title of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
+
+`-i --listId [listId]`
+: ID of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: Server- or web-relative URL of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Retrieves site columns for site _https://contoso.sharepoint.com/sites/contoso-sales_.
+
+```sh
+m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales
+```
+
+Retrieves list columns for list _Events_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
+
+```sh
+m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events
+```
+
+Retrieves list columns for list _202b8199-b9de-43fd-9737-7f213f51c991_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
+
+```sh
+m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991'
+```
+
+Retrieves list columns for list _/sites/contoso-sales/lists/Events_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
+
+```sh
+m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events'
+```

package/package.json

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