@pnp/cli-microsoft365 11.4.0-beta.13d597c → 11.4.0-beta.40f818c

package/dist/m365/tenant/commands/report/report-settings-set.js

@@ -3,12 +3,10 @@ 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({
-    displayConcealedNames: zod.alias('d', z.boolean())
-})
-    .strict();
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    displayConcealedNames: z.boolean().alias('d')
+});
 class TenantReportSettingsSetCommand extends GraphCommand {
     get name() {
         return commands.REPORT_SETTINGS_SET;

package/dist/m365/viva/commands/engage/engage-community-user-add.js

@@ -1,6 +1,5 @@
 import { z } from 'zod';
 import { globalOptionsZod } from '../../../../Command.js';
-import { zod } from '../../../../utils/zod.js';
 import GraphCommand from '../../../base/GraphCommand.js';
 import commands from '../../commands.js';
 import { validation } from '../../../../utils/validation.js';
@@ -8,25 +7,21 @@ import { vivaEngage } from '../../../../utils/vivaEngage.js';
 import request from '../../../../request.js';
 import { entraUser } from '../../../../utils/entraUser.js';
 import { formatting } from '../../../../utils/formatting.js';
-const options = globalOptionsZod
-    .extend({
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
     communityId: z.string().optional(),
-    communityDisplayName: zod.alias('n', z.string().optional()),
-    entraGroupId: z.string()
-        .refine(id => validation.isValidGuid(id), id => ({
-        message: `'${id}' is not a valid GUID.`
-    })).optional(),
+    communityDisplayName: z.string().optional().alias('n'),
+    entraGroupId: z.uuid().optional(),
     ids: z.string()
-        .refine(ids => validation.isValidGuidArray(ids) === true, invalidIds => ({
-        message: `The following GUIDs are invalid: ${invalidIds}.`
-    })).optional(),
+        .refine(ids => validation.isValidGuidArray(ids) === true, {
+        error: e => `The following GUIDs are invalid: ${e.input}.`
+    }).optional(),
     userNames: z.string()
-        .refine(userNames => validation.isValidUserPrincipalNameArray(userNames) === true, invalidUserNames => ({
-        message: `The following user principal names are invalid: ${invalidUserNames}.`
-    })).optional(),
-    role: zod.alias('r', z.enum(['Admin', 'Member']))
-})
-    .strict();
+        .refine(userNames => validation.isValidUserPrincipalNameArray(userNames) === true, {
+        error: e => `The following user principal names are invalid: ${e.input}.`
+    }).optional(),
+    role: z.enum(['Admin', 'Member']).alias('r')
+});
 class VivaEngageCommunityUserAddCommand extends GraphCommand {
     get name() {
         return commands.ENGAGE_COMMUNITY_USER_ADD;
@@ -40,16 +35,16 @@ class VivaEngageCommunityUserAddCommand extends GraphCommand {
     getRefinedSchema(schema) {
         return schema
             .refine(options => [options.communityId, options.communityDisplayName, options.entraGroupId].filter(x => x !== undefined).length === 1, {
-            message: 'Specify either communityId, communityDisplayName, or entraGroupId, but not multiple.'
+            error: 'Specify either communityId, communityDisplayName, or entraGroupId, but not multiple.'
         })
             .refine(options => options.communityId || options.communityDisplayName || options.entraGroupId, {
-            message: 'Specify at least one of communityId, communityDisplayName, or entraGroupId.'
+            error: 'Specify at least one of communityId, communityDisplayName, or entraGroupId.'
         })
             .refine(options => options.ids || options.userNames, {
-            message: 'Specify either of ids or userNames.'
+            error: 'Specify either of ids or userNames.'
         })
-            .refine(options => options.userNames !== undefined || options.ids !== undefined, {
-            message: 'Specify either ids or userNames, but not both.'
+            .refine(options => typeof options.userNames !== 'undefined' || typeof options.ids !== 'undefined', {
+            error: 'Specify either ids or userNames, but not both.'
         });
     }
     async commandAction(logger, args) {

package/dist/m365/viva/commands/engage/engage-community-user-list.js

@@ -1,22 +1,16 @@
 import { z } from 'zod';
 import { globalOptionsZod } from '../../../../Command.js';
-import { zod } from '../../../../utils/zod.js';
 import GraphCommand from '../../../base/GraphCommand.js';
 import commands from '../../commands.js';
-import { validation } from '../../../../utils/validation.js';
 import { vivaEngage } from '../../../../utils/vivaEngage.js';
 import { odata } from '../../../../utils/odata.js';
-const options = globalOptionsZod
-    .extend({
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
     communityId: z.string().optional(),
-    communityDisplayName: zod.alias('n', z.string().optional()),
-    entraGroupId: z.string()
-        .refine(name => validation.isValidGuid(name), name => ({
-        message: `'${name}' is not a valid GUID.`
-    })).optional(),
-    role: zod.alias('r', z.enum(['Admin', 'Member']).optional())
-})
-    .strict();
+    communityDisplayName: z.string().optional().alias('n'),
+    entraGroupId: z.uuid().optional(),
+    role: z.enum(['Admin', 'Member']).optional().alias('r')
+});
 class VivaEngageCommunityUserListCommand extends GraphCommand {
     get name() {
         return commands.ENGAGE_COMMUNITY_USER_LIST;
@@ -30,10 +24,10 @@ class VivaEngageCommunityUserListCommand extends GraphCommand {
     getRefinedSchema(schema) {
         return schema
             .refine(options => [options.communityId, options.communityDisplayName, options.entraGroupId].filter(x => x !== undefined).length === 1, {
-            message: 'Specify either communityId, communityDisplayName, or entraGroupId, but not multiple.'
+            error: 'Specify either communityId, communityDisplayName, or entraGroupId, but not multiple.'
         })
             .refine(options => options.communityId || options.communityDisplayName || options.entraGroupId, {
-            message: 'Specify at least one of communityId, communityDisplayName, or entraGroupId.'
+            error: 'Specify at least one of communityId, communityDisplayName, or entraGroupId.'
         });
     }
     defaultProperties() {

package/dist/m365/viva/commands/engage/engage-community-user-remove.js

@@ -1,6 +1,5 @@
 import { z } from 'zod';
 import { globalOptionsZod } from '../../../../Command.js';
-import { zod } from '../../../../utils/zod.js';
 import GraphCommand from '../../../base/GraphCommand.js';
 import commands from '../../commands.js';
 import { validation } from '../../../../utils/validation.js';
@@ -8,25 +7,18 @@ import { vivaEngage } from '../../../../utils/vivaEngage.js';
 import request from '../../../../request.js';
 import { entraUser } from '../../../../utils/entraUser.js';
 import { cli } from '../../../../cli/cli.js';
-const options = globalOptionsZod
-    .extend({
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
     communityId: z.string().optional(),
-    communityDisplayName: zod.alias('n', z.string().optional()),
-    entraGroupId: z.string()
-        .refine(id => validation.isValidGuid(id), id => ({
-        message: `'${id}' is not a valid GUID.`
-    })).optional(),
-    id: z.string()
-        .refine(id => validation.isValidGuid(id), id => ({
-        message: `'${id}' is not a valid GUID.`
-    })).optional(),
+    communityDisplayName: z.string().optional().alias('n'),
+    entraGroupId: z.uuid().optional(),
+    id: z.uuid().optional(),
     userName: z.string()
-        .refine(userName => validation.isValidUserPrincipalName(userName), userName => ({
-        message: `'${userName}' is not a valid user principal name.`
-    })).optional(),
+        .refine(userName => validation.isValidUserPrincipalName(userName), {
+        error: e => `'${e.input}' is not a valid user principal name.`
+    }).optional(),
     force: z.boolean().optional()
-})
-    .strict();
+});
 class VivaEngageCommunityUserRemoveCommand extends GraphCommand {
     get name() {
         return commands.ENGAGE_COMMUNITY_USER_REMOVE;
@@ -40,16 +32,16 @@ class VivaEngageCommunityUserRemoveCommand extends GraphCommand {
     getRefinedSchema(schema) {
         return schema
             .refine(options => [options.communityId, options.communityDisplayName, options.entraGroupId].filter(x => x !== undefined).length === 1, {
-            message: 'Specify either communityId, communityDisplayName, or entraGroupId, but not multiple.'
+            error: 'Specify either communityId, communityDisplayName, or entraGroupId, but not multiple.'
         })
             .refine(options => options.communityId || options.communityDisplayName || options.entraGroupId, {
-            message: 'Specify at least one of communityId, communityDisplayName, or entraGroupId.'
+            error: 'Specify at least one of communityId, communityDisplayName, or entraGroupId.'
         })
             .refine(options => options.id || options.userName, {
-            message: 'Specify either of id or userName.'
+            error: 'Specify either of id or userName.'
         })
-            .refine(options => options.userName !== undefined || options.id !== undefined, {
-            message: 'Specify either id or userName, but not both.'
+            .refine(options => typeof options.userName !== 'undefined' || typeof options.id !== 'undefined', {
+            error: 'Specify either id or userName, but not both.'
         });
     }
     async commandAction(logger, args) {

package/dist/m365/viva/commands/engage/engage-role-member-list.js

@@ -1,19 +1,14 @@
 import { z } from 'zod';
 import { globalOptionsZod } from '../../../../Command.js';
-import { zod } from '../../../../utils/zod.js';
 import { odata } from '../../../../utils/odata.js';
 import GraphCommand from '../../../base/GraphCommand.js';
 import commands from '../../commands.js';
-import { validation } from '../../../../utils/validation.js';
 import { vivaEngage } from '../../../../utils/vivaEngage.js';
-const options = globalOptionsZod
-    .extend({
-    roleId: zod.alias('i', z.string().refine(name => validation.isValidGuid(name), name => ({
-        message: `'${name}' is not a valid GUID.`
-    })).optional()),
-    roleName: zod.alias('n', z.string().optional())
-})
-    .strict();
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    roleId: z.uuid().optional().alias('i'),
+    roleName: z.string().optional().alias('n')
+});
 class VivaEngageRoleMemberListCommand extends GraphCommand {
     get name() {
         return commands.ENGAGE_ROLE_MEMBER_LIST;
@@ -27,7 +22,7 @@ class VivaEngageRoleMemberListCommand extends GraphCommand {
     getRefinedSchema(schema) {
         return schema
             .refine(options => [options.roleId, options.roleName].filter(x => x !== undefined).length === 1, {
-            message: 'Specify either roleId, or roleName, but not both.'
+            error: 'Specify either roleId, or roleName, but not both.'
         });
     }
     defaultProperties() {

package/dist/utils/spo.js

@@ -11,6 +11,7 @@ import { RoleType } from '../m365/spo/commands/roledefinition/RoleType.js';
 import { entraGroup } from './entraGroup.js';
 import { SharingCapabilities } from '../m365/spo/commands/site/SharingCapabilities.js';
 import { timersUtil } from './timersUtil.js';
+import { DOMParser } from '@xmldom/xmldom';
 export var CreateFileCopyJobsNameConflictBehavior;
 (function (CreateFileCopyJobsNameConflictBehavior) {
     CreateFileCopyJobsNameConflictBehavior[CreateFileCopyJobsNameConflictBehavior["Fail"] = 0] = "Fail";
@@ -1847,6 +1848,34 @@ export const spo = {
         roleDefinition.BasePermissionsValue = permissions.parse();
         roleDefinition.RoleTypeKindValue = RoleType[roleDefinition.RoleTypeKind];
         return roleDefinition;
+    },
+    /**
+     * Converts SharePoint default column values XML to a structured JSON array.
+     * Parses the XML content from client_LocationBasedDefaults.html file and extracts
+     * default field values configured for folders in a SharePoint document library.
+     *
+     * @param xml The XML string containing default column value definitions
+     * @returns An array of default column values with field names, values, and associated folder URLs
+     */
+    convertDefaultColumnXmlToJson(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;
     }
 };
 //# sourceMappingURL=spo.js.map

package/dist/utils/zod.js

@@ -1,114 +1,74 @@
 import { z } from 'zod';
-function parseEffect(def, _options, _currentOption) {
-    return def.schema._def;
-}
-function parseIntersection(def, _options, _currentOption) {
-    if (def.left._def.typeName !== z.ZodFirstPartyTypeKind.ZodAny) {
-        return def.left._def;
-    }
-    if (def.right._def.typeName !== z.ZodFirstPartyTypeKind.ZodAny) {
-        return def.right._def;
-    }
-    return;
-}
-function parseObject(def, options, _currentOption) {
-    const properties = def.shape();
-    for (const key in properties) {
-        const property = properties[key];
+z.ZodType.prototype.alias = function (name) {
+    this.def.alias = name;
+    return this;
+};
+function parseObject(schema, options, _currentOption) {
+    for (const key in schema.properties) {
+        const property = schema.properties[key];
         const option = {
             name: key,
             long: key,
-            short: property._def.alias,
-            required: true,
+            short: property['x-alias'],
+            required: schema.required?.includes(key) && property.default === undefined || false,
             type: 'string'
         };
-        parseDef(property._def, options, option);
+        parseJSONSchema(property, options, option);
         options.push(option);
     }
     return;
 }
-function parseString(_def, _options, currentOption) {
+function parseString(schema, _options, currentOption) {
     if (currentOption) {
         currentOption.type = 'string';
+        if (schema.enum) {
+            currentOption.autocomplete = schema.enum.map(e => String(e));
+        }
     }
     return;
 }
-function parseNumber(_def, _options, currentOption) {
+function parseNumber(schema, _options, currentOption) {
     if (currentOption) {
         currentOption.type = 'number';
     }
     return;
 }
-function parseBoolean(_def, _options, currentOption) {
+function parseBoolean(schema, _options, currentOption) {
     if (currentOption) {
         currentOption.type = 'boolean';
     }
     return;
 }
-function parseOptional(def, _options, currentOption) {
-    if (currentOption) {
-        currentOption.required = false;
-    }
-    return def.innerType._def;
-}
-function parseDefault(def, _options, currentOption) {
-    if (currentOption) {
-        currentOption.required = false;
-    }
-    return def.innerType._def;
-}
-function parseEnum(def, _options, currentOption) {
-    if (currentOption) {
-        currentOption.type = 'string';
-        currentOption.autocomplete = [...def.values];
-    }
-    return;
-}
-function parseNativeEnum(def, _options, currentOption) {
-    if (currentOption) {
-        currentOption.type = 'string';
-        currentOption.autocomplete = Object.values(def.values).map(v => String(v));
-    }
-    return;
-}
 function getParseFn(typeName) {
     switch (typeName) {
-        case z.ZodFirstPartyTypeKind.ZodEffects:
-            return parseEffect;
-        case z.ZodFirstPartyTypeKind.ZodObject:
+        case 'object':
             return parseObject;
-        case z.ZodFirstPartyTypeKind.ZodOptional:
-            return parseOptional;
-        case z.ZodFirstPartyTypeKind.ZodString:
+        case 'string':
             return parseString;
-        case z.ZodFirstPartyTypeKind.ZodNumber:
+        case 'number':
+        case 'integer':
             return parseNumber;
-        case z.ZodFirstPartyTypeKind.ZodBoolean:
+        case 'boolean':
             return parseBoolean;
-        case z.ZodFirstPartyTypeKind.ZodEnum:
-            return parseEnum;
-        case z.ZodFirstPartyTypeKind.ZodNativeEnum:
-            return parseNativeEnum;
-        case z.ZodFirstPartyTypeKind.ZodDefault:
-            return parseDefault;
-        case z.ZodFirstPartyTypeKind.ZodIntersection:
-            return parseIntersection;
         default:
             return;
     }
 }
-function parseDef(def, options, currentOption) {
-    let parsedDef = def;
+function parseJSONSchema(jsonSchema, options, currentOption) {
+    let parsedSchema = jsonSchema;
     do {
-        const parse = getParseFn(parsedDef.typeName);
+        if (parsedSchema.allOf) {
+            parsedSchema.allOf.forEach(s => parseJSONSchema(s, options, currentOption));
+        }
+        const parse = getParseFn(parsedSchema.type);
         if (!parse) {
             break;
         }
-        parsedDef = parse(parsedDef, options, currentOption);
-        if (!parsedDef) {
+        parsedSchema = parse(parsedSchema, options, currentOption);
+        if (!parsedSchema) {
             break;
         }
-    } while (parsedDef);
+    } while (parsedSchema);
 }
 function optionToString(optionInfo) {
     let s = '';
@@ -126,13 +86,18 @@ function optionToString(optionInfo) {
 }
 ;
 export const zod = {
-    alias(alias, type) {
-        type._def.alias = alias;
-        return type;
-    },
     schemaToOptionInfo(schema) {
+        const jsonSchema = z.toJSONSchema(schema, {
+            override: s => {
+                const alias = s.zodSchema.def.alias;
+                if (alias) {
+                    s.jsonSchema['x-alias'] = alias;
+                }
+            },
+            unrepresentable: 'any'
+        });
         const options = [];
-        parseDef(schema._def, options);
+        parseJSONSchema(jsonSchema, options);
         return options;
     },
     schemaToOptions(schema) {
@@ -153,6 +118,6 @@ export const zod = {
             }
         }
         return null;
-    }, z.nativeEnum(e))
+    }, z.enum(e))
 };
 //# sourceMappingURL=zod.js.map

package/docs/docs/cmd/entra/app/app-permission-add.mdx

@@ -46,6 +46,25 @@ m365 entra appregistration permission add [options]
 
 Scopes/Roles to grant must be fully-qualified so that we can disambiguate them between the different resources.
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource         | Permissions               |
+  |------------------|---------------------------|
+  | Microsoft Graph  | Application.ReadWrite.All |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource         | Permissions               |
+  |------------------|---------------------------|
+  | Microsoft Graph  | Application.ReadWrite.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Grant multiple delegated API permissions to a Microsoft Entra app specified by client id.

package/docs/docs/cmd/entra/app/app-permission-list.mdx

@@ -34,6 +34,25 @@ m365 entra app permission list [options]
 
 For best performance use the `objectId` option to reference the Entra application registration to get. If you use `appId`, this command will first need to find the corresponding object ID for that application.
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource         | Permissions          |
+  |------------------|----------------------|
+  | Microsoft Graph  | Application.Read.All |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource         | Permissions          |
+  |------------------|----------------------|
+  | Microsoft Graph  | Application.Read.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Retrieves all permissions for an Entra application registration specified by client id.

package/docs/docs/cmd/entra/app/app-permission-remove.mdx

@@ -1,4 +1,6 @@
 import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 
 # entra app permission remove
 
@@ -41,6 +43,25 @@ m365 entra app permission remove [options]
 
 Removing permissions on App Registrations does not immediately remove consent given by an administrator. Explicitly instruct the CLI to revoke consent by using the `--revokeAdminConsent` flag.
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource         | Permissions               |
+  |------------------|---------------------------|
+  | Microsoft Graph  | Application.ReadWrite.All |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource         | Permissions               |
+  |------------------|---------------------------|
+  | Microsoft Graph  | Application.ReadWrite.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Remove multiple delegated API permissions from an Entra app registration

package/docs/docs/cmd/spo/list/list-defaultvalue-get.mdx

@@ -0,0 +1,118 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo list defaultvalue get
+
+Gets a specific default column value from a specific document library
+
+## Usage
+
+```sh
+m365 spo list defaultvalue get [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the list is located.
+
+`-i, --listId [listId]`
+: ID of the list. Specify either `listTitle`, `listId`, or `listUrl`.
+
+`-t, --listTitle [listTitle]`
+: Title of the list. Specify either `listTitle`, `listId`, or `listUrl`.
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list. Specify either `listTitle`, `listId`, or `listUrl`.
+
+`--fieldName <fieldName>`
+: Internal name of the field.
+
+`--folderUrl [folderUrl]`
+: Get a specific field of a specific folder by specifying a server- or site-relative URL.
+```
+
+<Global />
+
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource   | Permissions   |
+  |------------|---------------|
+  | SharePoint | AllSites.Read |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource   | Permissions    |
+  |------------|----------------|
+  | SharePoint | Sites.Read.All |
+
+  </TabItem>
+</Tabs>
+
+## Examples
+
+Get default column value from the root folder of the list
+
+```sh
+m365 spo list defaultvalue get --webUrl https://contoso.sharepoint.com/sites/Marketing --listTitle Logos --fieldName Company
+```
+
+Get default column value from a specific folder of the list
+
+```sh
+m365 spo list defaultvalue get --webUrl https://contoso.sharepoint.com/sites/Marketing --listTitle Logos --fieldName Company --folderUrl "/sites/Marketing/Logos/Contoso"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "fieldName": "Company",
+    "fieldValue": "Contoso",
+    "folderUrl": "sites/Marketing/Logos"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  fieldName : Company
+  fieldValue: Contoso
+  folderUrl : sites/Marketing/Logos
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  fieldName,fieldValue,folderUrl
+  Company,Contoso,sites/Marketing/Logos
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo list defaultvalue get --webUrl "https://contoso.sharepoint.com/sites/Marketing" --listTitle "Logos" --fieldName "Company"
+
+  Date: 2/20/2023
+
+  Property | Value
+  ---------|-------
+  fieldName | Company
+  fieldValue | Contoso
+  folderUrl | sites/Marketing/Logos
+  ```
+
+  </TabItem>
+</Tabs>