@pnp/cli-microsoft365 10.3.0-beta.f5e6f85 → 10.3.1

package/dist/appInsights.js

@@ -12,7 +12,7 @@ import url from 'url';
 import { app } from './utils/app.js';
 const __dirname = url.fileURLToPath(new URL('.', import.meta.url));
 appInsights
-    .setup('6b908c80-d09f-4cf6-8274-e54349a0149a')
+    .setup('InstrumentationKey=6b908c80-d09f-4cf6-8274-e54349a0149a;IngestionEndpoint=https://westeurope-3.in.applicationinsights.azure.com/;LiveEndpoint=https://westeurope.livediagnostics.monitor.azure.com/;ApplicationId=d42020c6-da32-44f7-bbb7-666f0b3a664d')
     .setInternalLogging(false, false);
 // append -dev to the version number when ran locally
 // to distinguish production and dev version of the CLI

package/dist/config.js

@@ -35,6 +35,7 @@ export default {
         'https://graph.microsoft.com/Policy.Read.All',
         'https://graph.microsoft.com/RecordsManagement.ReadWrite.All',
         'https://graph.microsoft.com/Reports.Read.All',
+        'https://graph.microsoft.com/ReportSettings.ReadWrite.All',
         'https://graph.microsoft.com/RoleAssignmentSchedule.ReadWrite.Directory',
         'https://graph.microsoft.com/RoleEligibilitySchedule.Read.Directory',
         'https://graph.microsoft.com/SecurityEvents.Read.All',

package/dist/m365/entra/commands/app/app-add.js

@@ -476,6 +476,9 @@ _a = EntraAppAddCommand, _EntraAppAddCommand_instances = new WeakSet(), _EntraAp
         if (args.options.redirectUris && !args.options.platform) {
             return `When you specify redirectUris you also need to specify platform`;
         }
+        if (args.options.platform && ['spa', 'web', 'publicClient'].indexOf(args.options.platform) > -1 && !args.options.redirectUris) {
+            return `When you use platform spa, web or publicClient, you'll need to specify redirectUris`;
+        }
         if (args.options.certificateFile && args.options.certificateBase64Encoded) {
             return 'Specify either certificateFile or certificateBase64Encoded but not both';
         }

package/dist/m365/entra/commands/rolepermission/rolepermission-list.js

@@ -0,0 +1,42 @@
+import { odata } from '../../../../utils/odata.js';
+import GraphCommand from '../../../base/GraphCommand.js';
+import commands from '../../commands.js';
+import { z } from 'zod';
+import { globalOptionsZod } from '../../../../Command.js';
+import { zod } from '../../../../utils/zod.js';
+const options = globalOptionsZod
+    .extend({
+    resourceNamespace: zod.alias('n', z.string()),
+    privileged: zod.alias('p', z.boolean().optional())
+})
+    .strict();
+class EntraRolePermissionListCommand extends GraphCommand {
+    get name() {
+        return commands.ROLEPERMISSION_LIST;
+    }
+    get description() {
+        return 'Lists all Microsoft Entra ID role permissions';
+    }
+    defaultProperties() {
+        return ['id', 'name', 'actionVerb', 'isPrivileged'];
+    }
+    get schema() {
+        return options;
+    }
+    async commandAction(logger, args) {
+        if (this.verbose) {
+            await logger.logToStderr('Getting Microsoft Entra ID role permissions...');
+        }
+        try {
+            const queryString = args.options.privileged ? '?$filter=isPrivileged eq true' : '';
+            const url = `${this.resource}/beta/roleManagement/directory/resourceNamespaces/${args.options.resourceNamespace}/resourceActions${queryString}`;
+            const results = await odata.getAllItems(url);
+            await logger.log(results);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+}
+export default new EntraRolePermissionListCommand();
+//# sourceMappingURL=rolepermission-list.js.map

package/dist/m365/entra/commands.js

@@ -93,6 +93,7 @@ export default {
     ROLEDEFINITION_GET: `${prefix} roledefinition get`,
     ROLEDEFINITION_REMOVE: `${prefix} roledefinition remove`,
     ROLEDEFINITION_SET: `${prefix} roledefinition set`,
+    ROLEPERMISSION_LIST: `${prefix} rolepermission list`,
     SITECLASSIFICATION_DISABLE: `${prefix} siteclassification disable`,
     SITECLASSIFICATION_ENABLE: `${prefix} siteclassification enable`,
     SITECLASSIFICATION_GET: `${prefix} siteclassification get`,

package/dist/m365/spe/commands/container/container-activate.js

@@ -0,0 +1,50 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SpeContainerActivateCommand_instances, _SpeContainerActivateCommand_initOptions, _SpeContainerActivateCommand_initTypes;
+import GraphCommand from '../../../base/GraphCommand.js';
+import commands from '../../commands.js';
+import request from '../../../../request.js';
+import { formatting } from '../../../../utils/formatting.js';
+class SpeContainerActivateCommand extends GraphCommand {
+    get name() {
+        return commands.CONTAINER_ACTIVATE;
+    }
+    get description() {
+        return 'Activates a container';
+    }
+    constructor() {
+        super();
+        _SpeContainerActivateCommand_instances.add(this);
+        __classPrivateFieldGet(this, _SpeContainerActivateCommand_instances, "m", _SpeContainerActivateCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _SpeContainerActivateCommand_instances, "m", _SpeContainerActivateCommand_initTypes).call(this);
+    }
+    async commandAction(logger, args) {
+        if (this.verbose) {
+            await logger.logToStderr(`Activating a container with id '${args.options.id}'...`);
+        }
+        try {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/storage/fileStorage/containers/${formatting.encodeQueryParameter(args.options.id)}/activate`,
+                headers: {
+                    'content-type': 'application/json;odata=nometadata',
+                    'accept': 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            await request.post(requestOptions);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+}
+_SpeContainerActivateCommand_instances = new WeakSet(), _SpeContainerActivateCommand_initOptions = function _SpeContainerActivateCommand_initOptions() {
+    this.options.unshift({ option: '-i, --id <id>' });
+}, _SpeContainerActivateCommand_initTypes = function _SpeContainerActivateCommand_initTypes() {
+    this.types.string.push('id');
+};
+export default new SpeContainerActivateCommand();
+//# sourceMappingURL=container-activate.js.map

package/dist/m365/spe/commands.js

@@ -1,5 +1,6 @@
 const prefix = 'spe';
 export default {
+    CONTAINER_ACTIVATE: `${prefix} container activate`,
     CONTAINER_GET: `${prefix} container get`,
     CONTAINER_LIST: `${prefix} container list`,
     CONTAINERTYPE_ADD: `${prefix} containertype add`,

package/dist/m365/spo/commands/list/list-defaultvalue-clear.js

@@ -0,0 +1,184 @@
+import SpoCommand from '../../../base/SpoCommand.js';
+import { globalOptionsZod } from '../../../../Command.js';
+import { z } from 'zod';
+import { zod } from '../../../../utils/zod.js';
+import commands from '../../commands.js';
+import { DOMParser } from '@xmldom/xmldom';
+import { validation } from '../../../../utils/validation.js';
+import { urlUtil } from '../../../../utils/urlUtil.js';
+import request from '../../../../request.js';
+import { formatting } from '../../../../utils/formatting.js';
+import { cli } from '../../../../cli/cli.js';
+const options = globalOptionsZod
+    .extend({
+    webUrl: zod.alias('u', z.string()
+        .refine(url => validation.isValidSharePointUrl(url) === true, url => ({
+        message: `'${url}' is not a valid SharePoint Online site URL.`
+    }))),
+    listId: zod.alias('i', z.string().optional()
+        .refine(id => id === undefined || validation.isValidGuid(id), id => ({
+        message: `'${id}' is not a valid GUID.`
+    }))),
+    listTitle: zod.alias('t', z.string().optional()),
+    listUrl: z.string().optional(),
+    fieldName: z.string().optional(),
+    folderUrl: z.string().optional(),
+    force: zod.alias('f', z.boolean().optional())
+})
+    .strict();
+class SpoListDefaultValueClearCommand extends SpoCommand {
+    get name() {
+        return commands.LIST_DEFAULTVALUE_CLEAR;
+    }
+    get description() {
+        return 'Clears default column values for a specific document library';
+    }
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => [options.listId, options.listTitle, options.listUrl].filter(o => o !== undefined).length === 1, {
+            message: 'Use one of the following options: listId, listTitle, listUrl.'
+        })
+            .refine(options => (options.fieldName !== undefined) !== (options.folderUrl !== undefined) || (options.fieldName === undefined && options.folderUrl === undefined), {
+            message: `Specify 'fieldName' or 'folderUrl', but not both.`
+        });
+    }
+    async commandAction(logger, args) {
+        if (!args.options.force) {
+            const result = await cli.promptForConfirmation({ message: `Are you sure you want to clear all default values${args.options.fieldName ? ` for field '${args.options.fieldName}'` : args.options.folderUrl ? ` for folder ${args.options.folderUrl}` : ''}?` });
+            if (!result) {
+                return;
+            }
+        }
+        try {
+            if (this.verbose) {
+                await logger.logToStderr(`Clearing all default column values${args.options.fieldName ? ` for field ${args.options.fieldName}` : args.options.folderUrl ? `for folder '${args.options.folderUrl}'` : ''}...`);
+                await logger.logToStderr(`Getting server-relative URL of the list...`);
+            }
+            const listServerRelUrl = await this.getServerRelativeListUrl(args.options);
+            if (this.verbose) {
+                await logger.logToStderr(`List server-relative URL: ${listServerRelUrl}`);
+                await logger.logToStderr(`Getting default column values...`);
+            }
+            const defaultValuesXml = await this.getDefaultColumnValuesXml(args.options.webUrl, listServerRelUrl);
+            if (defaultValuesXml === null) {
+                if (this.verbose) {
+                    await logger.logToStderr(`No default column values found.`);
+                }
+                return;
+            }
+            const trimmedXml = this.removeFieldsFromXml(defaultValuesXml, args.options);
+            await this.uploadDefaultColumnValuesXml(args.options.webUrl, listServerRelUrl, trimmedXml);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+    async getServerRelativeListUrl(options) {
+        const requestOptions = {
+            url: `${options.webUrl}/_api/Web`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        if (options.listUrl) {
+            const serverRelativeUrl = urlUtil.getServerRelativePath(options.webUrl, options.listUrl);
+            requestOptions.url += `/GetList('${formatting.encodeQueryParameter(serverRelativeUrl)}')`;
+        }
+        else if (options.listId) {
+            requestOptions.url += `/Lists('${options.listId}')`;
+        }
+        else if (options.listTitle) {
+            requestOptions.url += `/Lists/GetByTitle('${formatting.encodeQueryParameter(options.listTitle)}')`;
+        }
+        requestOptions.url += '?$expand=RootFolder&$select=RootFolder/ServerRelativeUrl,BaseTemplate';
+        try {
+            const response = await request.get(requestOptions);
+            if (response.BaseTemplate !== 101) {
+                throw `The specified list is not a document library.`;
+            }
+            return response.RootFolder.ServerRelativeUrl;
+        }
+        catch (error) {
+            if (error.status === 404) {
+                throw `List '${options.listId || options.listTitle || options.listUrl}' was not found.`;
+            }
+            throw error;
+        }
+    }
+    async getDefaultColumnValuesXml(webUrl, listServerRelUrl) {
+        try {
+            const requestOptions = {
+                url: `${webUrl}/_api/Web/GetFileByServerRelativePath(decodedUrl='${formatting.encodeQueryParameter(listServerRelUrl + '/Forms/client_LocationBasedDefaults.html')}')/$value`,
+                headers: {
+                    accept: 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            const defaultValuesXml = await request.get(requestOptions);
+            return defaultValuesXml;
+        }
+        catch (err) {
+            // For lists that have never had default column values set, the client_LocationBasedDefaults.html file does not exist.
+            if (err.status === 404) {
+                return null;
+            }
+            throw err;
+        }
+    }
+    removeFieldsFromXml(xml, options) {
+        if (!options.fieldName && !options.folderUrl) {
+            return '<MetadataDefaults />';
+        }
+        let folderUrlToRemove = null;
+        if (options.folderUrl) {
+            folderUrlToRemove = urlUtil.removeTrailingSlashes(urlUtil.getServerRelativePath(options.webUrl, options.folderUrl));
+        }
+        const parser = new DOMParser();
+        const doc = parser.parseFromString(xml, 'application/xml');
+        const folderLinks = doc.getElementsByTagName('a');
+        for (let i = 0; i < folderLinks.length; i++) {
+            const folderNode = folderLinks[i];
+            const folderUrl = folderNode.getAttribute('href');
+            if (folderUrlToRemove && folderUrlToRemove.toLowerCase() === decodeURIComponent(folderUrl).toLowerCase()) {
+                folderNode.parentNode.removeChild(folderNode);
+                break;
+            }
+            else if (options.fieldName) {
+                const defaultValues = folderNode.getElementsByTagName('DefaultValue');
+                for (let j = 0; j < defaultValues.length; j++) {
+                    const defaultValueNode = defaultValues[j];
+                    const fieldName = defaultValueNode.getAttribute('FieldName');
+                    if (fieldName.toLowerCase() === options.fieldName.toLowerCase()) {
+                        // Remove the entire folder node if it becomes empty
+                        if (folderNode.childNodes.length === 1) {
+                            folderNode.parentNode.removeChild(defaultValueNode.parentNode);
+                        }
+                        else {
+                            folderNode.removeChild(defaultValueNode);
+                        }
+                        break;
+                    }
+                }
+            }
+        }
+        return doc.toString();
+    }
+    async uploadDefaultColumnValuesXml(webUrl, listServerRelUrl, xml) {
+        const requestOptions = {
+            url: `${webUrl}/_api/Web/GetFileByServerRelativePath(decodedUrl='${formatting.encodeQueryParameter(listServerRelUrl + '/Forms/client_LocationBasedDefaults.html')}')/$value`,
+            headers: {
+                accept: 'application/json;odata=nometadata',
+                'If-Match': '*'
+            },
+            responseType: 'json',
+            data: xml
+        };
+        await request.put(requestOptions);
+    }
+}
+export default new SpoListDefaultValueClearCommand();
+//# sourceMappingURL=list-defaultvalue-clear.js.map

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

@@ -0,0 +1,181 @@
+import SpoCommand from '../../../base/SpoCommand.js';
+import { globalOptionsZod } from '../../../../Command.js';
+import { z } from 'zod';
+import { zod } from '../../../../utils/zod.js';
+import commands from '../../commands.js';
+import { DOMParser } from '@xmldom/xmldom';
+import { validation } from '../../../../utils/validation.js';
+import { urlUtil } from '../../../../utils/urlUtil.js';
+import request from '../../../../request.js';
+import { formatting } from '../../../../utils/formatting.js';
+import { cli } from '../../../../cli/cli.js';
+const options = globalOptionsZod
+    .extend({
+    webUrl: zod.alias('u', z.string()
+        .refine(url => validation.isValidSharePointUrl(url) === true, url => ({
+        message: `'${url}' is not a valid SharePoint Online site URL.`
+    }))),
+    listId: zod.alias('i', z.string().optional()
+        .refine(id => id === undefined || validation.isValidGuid(id), id => ({
+        message: `'${id}' is not a valid GUID.`
+    }))),
+    listTitle: zod.alias('t', z.string().optional()),
+    listUrl: z.string().optional(),
+    fieldName: z.string(),
+    folderUrl: z.string().optional(),
+    force: zod.alias('f', z.boolean().optional())
+})
+    .strict();
+class SpoListDefaultValueRemoveCommand extends SpoCommand {
+    get name() {
+        return commands.LIST_DEFAULTVALUE_REMOVE;
+    }
+    get description() {
+        return 'Removes a specific default column value for a specific document library';
+    }
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => [options.listId, options.listTitle, options.listUrl].filter(o => o !== undefined).length === 1, {
+            message: 'Use one of the following options: listId, listTitle, listUrl.'
+        });
+    }
+    async commandAction(logger, args) {
+        if (!args.options.force) {
+            const result = await cli.promptForConfirmation({ message: `Are you sure you want to remove default column value '${args.options.fieldName}' from ${args.options.folderUrl ? `'${args.options.folderUrl}'` : 'the root of the list'}?` });
+            if (!result) {
+                return;
+            }
+        }
+        try {
+            if (this.verbose) {
+                await logger.logToStderr(`Removing default column value '${args.options.fieldName}' from ${args.options.folderUrl ? `'${args.options.folderUrl}'` : 'the root of the list'}.`);
+                await logger.logToStderr(`Getting server-relative URL of the list...`);
+            }
+            const listServerRelUrl = await this.getServerRelativeListUrl(args.options);
+            let folderUrl = listServerRelUrl;
+            if (args.options.folderUrl) {
+                folderUrl = urlUtil.getServerRelativePath(args.options.webUrl, urlUtil.removeTrailingSlashes(args.options.folderUrl));
+            }
+            if (this.verbose) {
+                await logger.logToStderr(`Getting default column values...`);
+            }
+            const defaultValuesXml = await this.getDefaultColumnValuesXml(args.options.webUrl, listServerRelUrl);
+            const removeDefaultValueResult = this.removeFieldFromXml(defaultValuesXml, args.options.fieldName, folderUrl);
+            if (!removeDefaultValueResult.isFieldFound) {
+                throw `Default column value '${args.options.fieldName}' was not found.`;
+            }
+            if (this.verbose) {
+                await logger.logToStderr(`Uploading default column values to list...`);
+            }
+            await this.uploadDefaultColumnValuesXml(args.options.webUrl, listServerRelUrl, removeDefaultValueResult.xml);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+    async getServerRelativeListUrl(options) {
+        const requestOptions = {
+            url: `${options.webUrl}/_api/Web`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        if (options.listUrl) {
+            const serverRelativeUrl = urlUtil.getServerRelativePath(options.webUrl, options.listUrl);
+            requestOptions.url += `/GetList('${formatting.encodeQueryParameter(serverRelativeUrl)}')`;
+        }
+        else if (options.listId) {
+            requestOptions.url += `/Lists('${options.listId}')`;
+        }
+        else if (options.listTitle) {
+            requestOptions.url += `/Lists/GetByTitle('${formatting.encodeQueryParameter(options.listTitle)}')`;
+        }
+        requestOptions.url += '?$expand=RootFolder&$select=RootFolder/ServerRelativeUrl,BaseTemplate';
+        try {
+            const response = await request.get(requestOptions);
+            if (response.BaseTemplate !== 101) {
+                throw `The specified list is not a document library.`;
+            }
+            return response.RootFolder.ServerRelativeUrl;
+        }
+        catch (error) {
+            if (error.status === 404) {
+                throw `List '${options.listId || options.listTitle || options.listUrl}' was not found.`;
+            }
+            throw error;
+        }
+    }
+    async getDefaultColumnValuesXml(webUrl, listServerRelUrl) {
+        try {
+            const requestOptions = {
+                url: `${webUrl}/_api/Web/GetFileByServerRelativePath(decodedUrl='${formatting.encodeQueryParameter(listServerRelUrl + '/Forms/client_LocationBasedDefaults.html')}')/$value`,
+                headers: {
+                    accept: 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            const defaultValuesXml = await request.get(requestOptions);
+            return defaultValuesXml;
+        }
+        catch (err) {
+            // For lists that have never had default column values set, the client_LocationBasedDefaults.html file does not exist.
+            if (err.status === 404) {
+                return null;
+            }
+            throw err;
+        }
+    }
+    removeFieldFromXml(xml, fieldName, folderUrl) {
+        if (xml === null) {
+            return { isFieldFound: false };
+        }
+        // Encode all spaces in the folder URL
+        const encodedFolderUrl = folderUrl.replace(/ /g, '%20');
+        const parser = new DOMParser();
+        const doc = parser.parseFromString(xml, 'application/xml');
+        const folderLinks = doc.getElementsByTagName('a');
+        for (let i = 0; i < folderLinks.length; i++) {
+            const folderNode = folderLinks[i];
+            const folderNodeUrl = folderNode.getAttribute('href');
+            if (encodedFolderUrl.toLowerCase() !== folderNodeUrl.toLowerCase()) {
+                continue;
+            }
+            const defaultValues = folderNode.getElementsByTagName('DefaultValue');
+            for (let j = 0; j < defaultValues.length; j++) {
+                const defaultValueNode = defaultValues[j];
+                const defaultValueNodeField = defaultValueNode.getAttribute('FieldName');
+                if (defaultValueNodeField !== fieldName) {
+                    continue;
+                }
+                if (folderNode.childNodes.length === 1) {
+                    // No other default values found in the folder, let's remove the folder node
+                    folderNode.parentNode.removeChild(folderNode);
+                }
+                else {
+                    // Default value node found, let's remove it
+                    folderNode.removeChild(defaultValueNode);
+                }
+                return { isFieldFound: true, xml: doc.toString() };
+            }
+        }
+        return { isFieldFound: false };
+    }
+    async uploadDefaultColumnValuesXml(webUrl, listServerRelUrl, xml) {
+        const requestOptions = {
+            url: `${webUrl}/_api/Web/GetFileByServerRelativePath(decodedUrl='${formatting.encodeQueryParameter(listServerRelUrl + '/Forms/client_LocationBasedDefaults.html')}')/$value`,
+            headers: {
+                accept: 'application/json;odata=nometadata',
+                'content-type': 'text/plain'
+            },
+            responseType: 'json',
+            data: xml
+        };
+        await request.put(requestOptions);
+    }
+}
+export default new SpoListDefaultValueRemoveCommand();
+//# sourceMappingURL=list-defaultvalue-remove.js.map