@pnp/cli-microsoft365 11.4.0-beta.87732f5 → 11.4.0-beta.f54089d

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

@@ -0,0 +1,124 @@
+import commands from '../../commands.js';
+import SpoCommand from '../../../base/SpoCommand.js';
+import { globalOptionsZod } from '../../../../Command.js';
+import { z } from 'zod';
+import { validation } from '../../../../utils/validation.js';
+import { urlUtil } from '../../../../utils/urlUtil.js';
+import { spo } from '../../../../utils/spo.js';
+import request from '../../../../request.js';
+import { formatting } from '../../../../utils/formatting.js';
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    webUrl: z.string()
+        .refine(url => validation.isValidSharePointUrl(url) === true, {
+        error: e => `'${e.input}' is not a valid SharePoint Online site URL.`
+    })
+        .alias('u'),
+    listId: z.uuid().optional().alias('i'),
+    listTitle: z.string().optional().alias('t'),
+    listUrl: z.string().optional(),
+    fieldName: z.string(),
+    folderUrl: z.string().optional()
+});
+class SpoListDefaultValueGetCommand extends SpoCommand {
+    get name() {
+        return commands.LIST_DEFAULTVALUE_GET;
+    }
+    get description() {
+        return 'Gets a specific default column value from a list';
+    }
+    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, listUrl.'
+        });
+    }
+    async commandAction(logger, args) {
+        try {
+            if (this.verbose) {
+                await logger.logToStderr(`Retrieving default column value for field '${args.options.fieldName}' in list '${args.options.listId || args.options.listTitle || args.options.listUrl}'...`);
+                await logger.logToStderr('Retrieving list information...');
+            }
+            const listServerRelUrl = await this.getServerRelativeListUrl(args.options);
+            if (this.verbose) {
+                await logger.logToStderr('Retrieving default column values...');
+            }
+            let defaultValues;
+            try {
+                const defaultValuesXml = await this.getDefaultColumnValuesXml(args.options.webUrl, listServerRelUrl);
+                defaultValues = spo.convertDefaultColumnXmlToJson(defaultValuesXml);
+            }
+            catch (err) {
+                if (err.status !== 404) {
+                    throw err;
+                }
+                // For lists that have never had default column values set, the client_LocationBasedDefaults.html file does not exist.
+                defaultValues = [];
+            }
+            defaultValues = defaultValues.filter(d => d.fieldName.toLowerCase() === args.options.fieldName.toLowerCase());
+            if (args.options.folderUrl) {
+                const serverRelFolderUrl = urlUtil.removeTrailingSlashes(urlUtil.getServerRelativePath(args.options.webUrl, args.options.folderUrl));
+                defaultValues = defaultValues.filter(d => d.folderUrl.toLowerCase() === serverRelFolderUrl.toLowerCase());
+            }
+            else {
+                defaultValues = defaultValues.filter(d => d.folderUrl.toLowerCase() === listServerRelUrl.toLowerCase());
+            }
+            if (defaultValues.length === 0) {
+                throw `No default column value found for field '${args.options.fieldName}'${args.options.folderUrl ? ` in folder '${args.options.folderUrl}'` : ''}.`;
+            }
+            await logger.log(defaultValues[0]);
+        }
+        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('${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 `List '${options.listId || options.listTitle || options.listUrl}' 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) {
+        const requestOptions = {
+            url: `${webUrl}/_api/Web/GetFileByServerRelativePath(decodedUrl='${formatting.encodeQueryParameter(listServerRelUrl + '/Forms/client_LocationBasedDefaults.html')}')/$value`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'text'
+        };
+        const defaultValuesXml = await request.get(requestOptions);
+        return defaultValuesXml;
+    }
+}
+export default new SpoListDefaultValueGetCommand();
+//# sourceMappingURL=list-defaultvalue-get.js.map

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

@@ -1,28 +1,24 @@
 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 { spo } from '../../../../utils/spo.js';
 import request from '../../../../request.js';
 import { formatting } from '../../../../utils/formatting.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()),
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    webUrl: z.string()
+        .refine(url => validation.isValidSharePointUrl(url) === true, {
+        error: e => `'${e.input}' is not a valid SharePoint Online site URL.`
+    })
+        .alias('u'),
+    listId: z.uuid().optional().alias('i'),
+    listTitle: z.string().optional().alias('t'),
     listUrl: z.string().optional(),
     folderUrl: z.string().optional()
-})
-    .strict();
+});
 class SpoListDefaultValueListCommand extends SpoCommand {
     get name() {
         return commands.LIST_DEFAULTVALUE_LIST;
@@ -36,7 +32,7 @@ class SpoListDefaultValueListCommand extends SpoCommand {
     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.'
+            error: 'Use one of the following options: listId, listTitle, listUrl.'
         });
     }
     async commandAction(logger, args) {
@@ -52,7 +48,7 @@ class SpoListDefaultValueListCommand extends SpoCommand {
             let defaultValues;
             try {
                 const defaultValuesXml = await this.getDefaultColumnValuesXml(args.options.webUrl, listServerRelUrl);
-                defaultValues = this.convertXmlToJson(defaultValuesXml);
+                defaultValues = spo.convertDefaultColumnXmlToJson(defaultValuesXml);
             }
             catch (err) {
                 if (err.status !== 404) {
@@ -115,26 +111,6 @@ class SpoListDefaultValueListCommand extends SpoCommand {
         const defaultValuesXml = await request.get(requestOptions);
         return defaultValuesXml;
     }
-    convertXmlToJson(xml) {
-        const results = [];
-        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 folderUrl = folderLinks[i].getAttribute('href');
-            const defaultValues = folderLinks[i].getElementsByTagName('DefaultValue');
-            for (let j = 0; j < defaultValues.length; j++) {
-                const fieldName = defaultValues[j].getAttribute('FieldName');
-                const fieldValue = defaultValues[j].textContent;
-                results.push({
-                    fieldName: fieldName,
-                    fieldValue: fieldValue,
-                    folderUrl: decodeURIComponent(folderUrl)
-                });
-            }
-        }
-        return results;
-    }
 }
 export default new SpoListDefaultValueListCommand();
 //# sourceMappingURL=list-defaultvalue-list.js.map

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

@@ -1,7 +1,6 @@
 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';
@@ -9,23 +8,20 @@ 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()),
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    webUrl: z.string()
+        .refine(url => validation.isValidSharePointUrl(url) === true, {
+        error: e => `'${e.input}' is not a valid SharePoint Online site URL.`
+    })
+        .alias('u'),
+    listId: z.uuid().optional().alias('i'),
+    listTitle: z.string().optional().alias('t'),
     listUrl: z.string().optional(),
     fieldName: z.string(),
     folderUrl: z.string().optional(),
-    force: zod.alias('f', z.boolean().optional())
-})
-    .strict();
+    force: z.boolean().optional().alias('f')
+});
 class SpoListDefaultValueRemoveCommand extends SpoCommand {
     get name() {
         return commands.LIST_DEFAULTVALUE_REMOVE;
@@ -39,7 +35,7 @@ class SpoListDefaultValueRemoveCommand extends SpoCommand {
     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.'
+            error: 'Use one of the following options: listId, listTitle, listUrl.'
         });
     }
     async commandAction(logger, args) {

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

@@ -1,32 +1,28 @@
 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';
-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()),
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    webUrl: z.string()
+        .refine(url => validation.isValidSharePointUrl(url) === true, {
+        error: e => `'${e.input}' is not a valid SharePoint Online site URL.`
+    })
+        .alias('u'),
+    listId: z.uuid().optional().alias('i'),
+    listTitle: z.string().optional().alias('t'),
     listUrl: z.string().optional(),
     fieldName: z.string(),
     fieldValue: z.string()
         .refine(value => value !== '', `The value cannot be empty. Use 'spo list defaultvalue remove' to remove a default column value.`),
     folderUrl: z.string().optional()
         .refine(url => url === undefined || (!url.includes('#') && !url.includes('%')), 'Due to limitations in SharePoint Online, setting default column values for folders with a # or % character in their path is not supported.')
-})
-    .strict();
+});
 class SpoListDefaultValueSetCommand extends SpoCommand {
     get name() {
         return commands.LIST_DEFAULTVALUE_SET;
@@ -40,7 +36,7 @@ class SpoListDefaultValueSetCommand extends SpoCommand {
     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.'
+            error: 'Use one of the following options: listId, listTitle, listUrl.'
         });
     }
     async commandAction(logger, args) {

package/dist/m365/spo/commands/list/list-view-add.js

@@ -6,17 +6,14 @@ import { validation } from '../../../../utils/validation.js';
 import SpoCommand from '../../../base/SpoCommand.js';
 import commands from '../../commands.js';
 import { z } from 'zod';
-import { zod } from '../../../../utils/zod.js';
-const options = globalOptionsZod
-    .extend({
-    webUrl: zod.alias('u', z.string()
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    webUrl: z.string()
         .refine(url => validation.isValidSharePointUrl(url) === true, {
-        message: 'webUrl is not a valid SharePoint site URL.'
-    })),
-    listId: z.string()
-        .refine(id => validation.isValidGuid(id), id => ({
-        message: `'${id}' is not a valid GUID.`
-    })).optional(),
+        error: 'webUrl is not a valid SharePoint site URL.'
+    })
+        .alias('u'),
+    listId: z.uuid().optional(),
     listTitle: z.string().optional(),
     listUrl: z.string().optional(),
     title: z.string().min(1, 'Cannot be empty.'),
@@ -36,7 +33,7 @@ const options = globalOptionsZod
             return false;
         }
     }, {
-        message: 'Custom formatter must be a valid JSON string.'
+        error: 'Custom formatter must be a valid JSON string.'
     })
         .optional(),
     type: z.enum(['list', 'calendar', 'gallery', 'kanban']).optional(),
@@ -46,8 +43,7 @@ const options = globalOptionsZod
     calendarSubTitleField: z.string().min(1, 'Cannot be empty.').optional(),
     calendarDefaultLayout: z.enum(['month', 'week', 'workWeek', 'day']).optional(),
     kanbanBucketField: z.string().min(1, 'Cannot be empty.').optional()
-})
-    .strict();
+});
 class SpoListViewAddCommand extends SpoCommand {
     get name() {
         return commands.LIST_VIEW_ADD;
@@ -61,25 +57,25 @@ class SpoListViewAddCommand extends SpoCommand {
     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, or listUrl.'
+            error: 'Use one of the following options: listId, listTitle, or listUrl.'
         })
             .refine((options) => !options.personal || !options.default, {
-            message: 'Default view cannot be a personal view.'
+            error: 'Default view cannot be a personal view.'
         })
             .refine((options) => options.type !== 'calendar' || [options.calendarStartDateField, options.calendarEndDateField, options.calendarTitleField].filter(o => o === undefined).length === 0, {
-            message: 'When type is calendar, do specify calendarStartDateField, calendarEndDateField, and calendarTitleField.'
+            error: 'When type is calendar, do specify calendarStartDateField, calendarEndDateField, and calendarTitleField.'
         })
             .refine((options) => options.type === 'calendar' || [options.calendarStartDateField, options.calendarEndDateField, options.calendarTitleField].filter(o => o === undefined).length === 3, {
-            message: 'When type is not calendar, do not specify calendarStartDateField, calendarEndDateField, and calendarTitleField.'
+            error: 'When type is not calendar, do not specify calendarStartDateField, calendarEndDateField, and calendarTitleField.'
         })
             .refine((options) => options.type !== 'kanban' || options.kanbanBucketField !== undefined, {
-            message: 'When type is kanban, do specify kanbanBucketField.'
+            error: 'When type is kanban, do specify kanbanBucketField.'
         })
             .refine((options) => options.type === 'kanban' || options.kanbanBucketField === undefined, {
-            message: 'When type is not kanban, do not specify kanbanBucketField.'
+            error: 'When type is not kanban, do not specify kanbanBucketField.'
         })
             .refine((options) => options.type === 'calendar' || options.fields !== undefined, {
-            message: 'When type is not calendar, do specify fields.'
+            error: 'When type is not calendar, do specify fields.'
         });
     }
     async commandAction(logger, args) {

package/dist/m365/spo/commands/listitem/listitem-set.js

@@ -85,7 +85,7 @@ class SpoListItemSetCommand extends SpoCommand {
             }
             const properties = this.mapRequestBody(args.options);
             const item = args.options.systemUpdate ?
-                await spo.systemUpdateListItem(requestUrl, args.options.id, logger, this.verbose, properties, contentTypeName)
+                await spo.systemUpdateListItem(requestUrl, +args.options.id, logger, this.verbose, properties, contentTypeName)
                 : await spo.updateListItem(requestUrl, args.options.id, properties, contentTypeName);
             delete item.ID;
             await logger.log(item);

package/dist/m365/spo/commands/page/page-control-remove.js

@@ -3,27 +3,23 @@ import { z } from 'zod';
 import commands from '../../commands.js';
 import { validation } from '../../../../utils/validation.js';
 import SpoCommand from '../../../base/SpoCommand.js';
-import { zod } from '../../../../utils/zod.js';
 import { cli } from '../../../../cli/cli.js';
 import request from '../../../../request.js';
 import { formatting } from '../../../../utils/formatting.js';
 import { Page } from './Page.js';
 import { urlUtil } from '../../../../utils/urlUtil.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 URL.`
-    })),
-    pageName: zod.alias('n', z.string()),
-    id: zod.alias('i', z.string())
-        .refine(id => validation.isValidGuid(id), id => ({
-        message: `'${id}' is not a valid GUID.`
-    })),
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    webUrl: z.string()
+        .refine(url => validation.isValidSharePointUrl(url) === true, {
+        error: e => `'${e.input}' is not a valid SharePoint URL.`
+    })
+        .alias('u'),
+    pageName: z.string().alias('n'),
+    id: z.uuid().alias('i'),
     draft: z.boolean().optional(),
-    force: zod.alias('f', z.boolean().optional())
-})
-    .strict();
+    force: z.boolean().optional().alias('f')
+});
 class SpoPageControlRemoveCommand extends SpoCommand {
     get name() {
         return commands.PAGE_CONTROL_REMOVE;

package/dist/m365/spo/commands/page/page-get.js

@@ -1,5 +1,4 @@
 import { z } from 'zod';
-import { zod } from '../../../../utils/zod.js';
 import { globalOptionsZod } from '../../../../Command.js';
 import request from '../../../../request.js';
 import { formatting } from '../../../../utils/formatting.js';
@@ -7,17 +6,17 @@ import { urlUtil } from '../../../../utils/urlUtil.js';
 import { validation } from '../../../../utils/validation.js';
 import SpoCommand from '../../../base/SpoCommand.js';
 import commands from '../../commands.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.`
-    }))),
-    name: zod.alias('n', z.string()).optional(),
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    webUrl: z.string()
+        .refine(url => validation.isValidSharePointUrl(url) === true, {
+        error: e => `'${e.input}' is not a valid SharePoint Online site URL.`
+    })
+        .alias('u'),
+    name: z.string().optional().alias('n'),
     default: z.boolean().optional(),
     metadataOnly: z.boolean().optional()
-})
-    .strict();
+});
 class SpoPageGetCommand extends SpoCommand {
     get name() {
         return commands.PAGE_GET;
@@ -31,7 +30,7 @@ class SpoPageGetCommand extends SpoCommand {
     getRefinedSchema(schema) {
         return schema
             .refine(options => [options.name, options.default].filter(x => x !== undefined).length === 1, {
-            message: `Specify either name or default, but not both.`
+            error: `Specify either name or default, but not both.`
         });
     }
     async commandAction(logger, args) {