@pnp/cli-microsoft365 11.9.0-beta.93bd508 → 11.9.0-beta.f8dc984

package/dist/m365/spo/commands/list/list-sensitivitylabel-remove.js

@@ -0,0 +1,83 @@
+import { z } from 'zod';
+import { globalOptionsZod } from '../../../../Command.js';
+import request from '../../../../request.js';
+import { formatting } from '../../../../utils/formatting.js';
+import { urlUtil } from '../../../../utils/urlUtil.js';
+import { validation } from '../../../../utils/validation.js';
+import SpoCommand from '../../../base/SpoCommand.js';
+import commands from '../../commands.js';
+import { cli } from '../../../../cli/cli.js';
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    webUrl: z.string()
+        .refine(url => validation.isValidSharePointUrl(url) === true, {
+        error: 'Specify a valid SharePoint site URL.'
+    })
+        .alias('u'),
+    listTitle: z.string().optional().alias('t'),
+    listId: z.uuid().optional().alias('l'),
+    listUrl: z.string().optional(),
+    force: z.boolean().optional().alias('f')
+});
+class SpoListSensitivityLabelRemoveCommand extends SpoCommand {
+    get name() {
+        return commands.LIST_SENSITIVITYLABEL_REMOVE;
+    }
+    get description() {
+        return 'Clears a default sensitivity label from a document library';
+    }
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => [options.listId, options.listTitle, options.listUrl].filter(o => o !== undefined).length === 1, {
+            error: 'Use one of the following options: listId, listTitle, or listUrl.'
+        });
+    }
+    async commandAction(logger, args) {
+        const removeSensitivityLabel = async () => {
+            try {
+                if (this.verbose) {
+                    await logger.logToStderr(`Removing the sensitivity label from list '${args.options.listId || args.options.listTitle || args.options.listUrl}' in site at ${args.options.webUrl}...`);
+                }
+                let requestUrl = `${args.options.webUrl}/_api/web`;
+                if (args.options.listId) {
+                    requestUrl += `/lists(guid'${formatting.encodeQueryParameter(args.options.listId)}')`;
+                }
+                else if (args.options.listTitle) {
+                    requestUrl += `/lists/getByTitle('${formatting.encodeQueryParameter(args.options.listTitle)}')`;
+                }
+                else if (args.options.listUrl) {
+                    const listServerRelativeUrl = urlUtil.getServerRelativePath(args.options.webUrl, args.options.listUrl);
+                    requestUrl += `/GetList('${formatting.encodeQueryParameter(listServerRelativeUrl)}')`;
+                }
+                const requestOptions = {
+                    url: requestUrl,
+                    headers: {
+                        accept: 'application/json;odata=nometadata',
+                        'content-type': 'application/json;odata=nometadata',
+                        'if-match': '*'
+                    },
+                    data: { 'DefaultSensitivityLabelForLibrary': '' },
+                    responseType: 'json'
+                };
+                await request.patch(requestOptions);
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        };
+        if (args.options.force) {
+            await removeSensitivityLabel();
+        }
+        else {
+            const result = await cli.promptForConfirmation({ message: `Are you sure you want to remove the sensitivity label from list '${args.options.listId || args.options.listTitle || args.options.listUrl}'?` });
+            if (result) {
+                await removeSensitivityLabel();
+            }
+        }
+    }
+}
+export default new SpoListSensitivityLabelRemoveCommand();
+//# sourceMappingURL=list-sensitivitylabel-remove.js.map

package/dist/m365/spo/commands.js

@@ -162,6 +162,7 @@ export default {
     LIST_ROLEINHERITANCE_BREAK: `${prefix} list roleinheritance break`,
     LIST_ROLEINHERITANCE_RESET: `${prefix} list roleinheritance reset`,
     LIST_SENSITIVITYLABEL_ENSURE: `${prefix} list sensitivitylabel ensure`,
+    LIST_SENSITIVITYLABEL_REMOVE: `${prefix} list sensitivitylabel remove`,
     LIST_SET: `${prefix} list set`,
     LIST_SITESCRIPT_GET: `${prefix} list sitescript get`,
     LIST_VIEW_ADD: `${prefix} list view add`,

package/docs/docs/cmd/spo/list/list-sensitivitylabel-remove.mdx

@@ -0,0 +1,77 @@
+import Global from '../../_global.mdx';
+import TabItem from '@theme/TabItem';
+import Tabs from '@theme/Tabs';
+
+# spo list sensitivitylabel remove
+
+Clears a default sensitivity label from a document library
+
+## Usage
+
+```sh
+m365 spo list sensitivitylabel remove [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the list is located.
+
+`-t, --listTitle [listTitle]`
+: The title of the library on which to remove the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
+
+`-l, --listId [listId]`
+: The ID of the library on which to remove the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
+
+`--listUrl [listUrl]`
+: Server- or web-relative URL of the library on which to remove the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
+
+`-f, --force`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource   | Permissions    |
+  |------------|----------------|
+  | SharePoint | AllSites.Write |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource   | Permissions         |
+  |------------|---------------------|  
+  | SharePoint | Sites.ReadWrite.All |
+
+  </TabItem>
+</Tabs>
+
+## Examples
+
+Removes a sensitivity label from a document library based on the list title.
+
+```sh
+m365 spo list sensitivitylabel remove --webUrl 'https://contoso.sharepoint.com' --listTitle 'Shared Documents'
+```
+
+Removes a sensitivity label from a document library based on the list url.
+
+```sh
+m365 spo list sensitivitylabel remove --webUrl 'https://contoso.sharepoint.com' --listUrl '/Shared Documents'
+```
+
+Removes a sensitivity label from a document library based on the list id without prompting for confirmation.
+
+```sh
+m365 spo list sensitivitylabel remove --webUrl 'https://contoso.sharepoint.com' --listId 'b4cfa0d9-b3d7-49ae-a0f0-f14ffdd005f7' --force
+```
+
+## Response
+
+The command won't return a response on success.

package/package.json

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