@pnp/cli-microsoft365 10.11.0 → 11.0.0-beta.3655c37

package/dist/m365/outlook/commands/mail/mail-searchfolder-add.js

@@ -0,0 +1,85 @@
+import request from '../../../../request.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';
+import { validation } from '../../../../utils/validation.js';
+import { accessToken } from '../../../../utils/accessToken.js';
+import auth from '../../../../Auth.js';
+const options = globalOptionsZod
+    .extend({
+    userId: zod.alias('i', z.string()
+        .refine(userId => validation.isValidGuid(userId), userId => ({
+        message: `'${userId}' is not a valid GUID.`
+    })).optional()),
+    userName: zod.alias('n', z.string()
+        .refine(userName => validation.isValidUserPrincipalName(userName), userName => ({
+        message: `'${userName}' is not a valid UPN.`
+    })).optional()),
+    folderName: z.string(),
+    messageFilter: z.string(),
+    sourceFoldersIds: z.string().transform((value) => value.split(',')).pipe(z.string().array()),
+    includeNestedFolders: z.boolean().optional()
+})
+    .strict();
+class OutlookMailSearchFolderAddCommand extends GraphCommand {
+    get name() {
+        return commands.MAIL_SEARCHFOLDER_ADD;
+    }
+    get description() {
+        return `Creates a new mail search folder in the user's mailbox`;
+    }
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => !(options.userId && options.userName), {
+            message: 'Specify either userId or userName, but not both'
+        });
+    }
+    async commandAction(logger, args) {
+        try {
+            const isAppOnlyAccessToken = accessToken.isAppOnlyAccessToken(auth.connection.accessTokens[auth.defaultResource].accessToken);
+            let requestUrl = `${this.resource}/v1.0/me/mailFolders/searchFolders/childFolders`;
+            if (isAppOnlyAccessToken) {
+                if (!args.options.userId && !args.options.userName) {
+                    throw 'When running with application permissions either userId or userName is required';
+                }
+                const userIdentifier = args.options.userId ?? args.options.userName;
+                requestUrl = `${this.resource}/v1.0/users('${userIdentifier}')/mailFolders/searchFolders/childFolders`;
+                if (args.options.verbose) {
+                    await logger.logToStderr(`Creating a mail search folder in the mailbox of the user ${userIdentifier}...`);
+                }
+            }
+            else {
+                if (args.options.userId || args.options.userName) {
+                    throw 'You can create mail search folder for other users only if CLI is authenticated in app-only mode';
+                }
+            }
+            const requestOptions = {
+                url: requestUrl,
+                headers: {
+                    accept: 'application/json;odata.metadata=none',
+                    'content-type': 'application/json'
+                },
+                responseType: 'json',
+                data: {
+                    '@odata.type': '#microsoft.graph.mailSearchFolder',
+                    displayName: args.options.folderName,
+                    includeNestedFolders: args.options.includeNestedFolders,
+                    filterQuery: args.options.messageFilter,
+                    sourceFolderIds: args.options.sourceFoldersIds
+                }
+            };
+            const result = await request.post(requestOptions);
+            await logger.log(result);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+}
+export default new OutlookMailSearchFolderAddCommand();
+//# sourceMappingURL=mail-searchfolder-add.js.map

package/dist/m365/outlook/commands.js

@@ -1,5 +1,6 @@
 const prefix = 'outlook';
 export default {
+    MAIL_SEARCHFOLDER_ADD: `${prefix} mail searchfolder add`,
     MAIL_SEND: `${prefix} mail send`,
     MAILBOX_SETTINGS_GET: `${prefix} mailbox settings get`,
     MAILBOX_SETTINGS_SET: `${prefix} mailbox settings set`,

package/dist/m365/pa/commands/environment/environment-get.js

@@ -1,13 +1,16 @@
-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 _PaEnvironmentGetCommand_instances, _PaEnvironmentGetCommand_initTelemetry, _PaEnvironmentGetCommand_initOptions;
+import { z } from 'zod';
+import { globalOptionsZod } from '../../../../Command.js';
 import request from '../../../../request.js';
 import { formatting } from '../../../../utils/formatting.js';
+import { zod } from '../../../../utils/zod.js';
 import PowerAppsCommand from '../../../base/PowerAppsCommand.js';
 import commands from '../../commands.js';
+const options = globalOptionsZod
+    .extend({
+    name: zod.alias('n', z.string().optional()),
+    default: z.boolean().optional()
+})
+    .strict();
 class PaEnvironmentGetCommand extends PowerAppsCommand {
     get name() {
         return commands.ENVIRONMENT_GET;
@@ -15,17 +18,20 @@ class PaEnvironmentGetCommand extends PowerAppsCommand {
     get description() {
         return 'Gets information about the specified Microsoft Power Apps environment';
     }
-    constructor() {
-        super();
-        _PaEnvironmentGetCommand_instances.add(this);
-        __classPrivateFieldGet(this, _PaEnvironmentGetCommand_instances, "m", _PaEnvironmentGetCommand_initTelemetry).call(this);
-        __classPrivateFieldGet(this, _PaEnvironmentGetCommand_instances, "m", _PaEnvironmentGetCommand_initOptions).call(this);
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => !!options.name !== !!options.default, {
+            message: `Specify either name or default, but not both.`
+        });
     }
     async commandAction(logger, args) {
         if (this.verbose) {
             await logger.logToStderr(`Retrieving information about Microsoft Power Apps environment ${args.options.name || 'default'}...`);
         }
-        const environmentName = args.options.name ? formatting.encodeQueryParameter(args.options.name) : '~default';
+        const environmentName = args.options.default ? '~default' : formatting.encodeQueryParameter(args.options.name);
         const requestOptions = {
             url: `${this.resource}/providers/Microsoft.PowerApps/environments/${environmentName}?api-version=2016-11-01`,
             headers: {
@@ -47,16 +53,5 @@ class PaEnvironmentGetCommand extends PowerAppsCommand {
         }
     }
 }
-_PaEnvironmentGetCommand_instances = new WeakSet(), _PaEnvironmentGetCommand_initTelemetry = function _PaEnvironmentGetCommand_initTelemetry() {
-    this.telemetry.push((args) => {
-        Object.assign(this.telemetryProperties, {
-            name: typeof args.options.name !== 'undefined'
-        });
-    });
-}, _PaEnvironmentGetCommand_initOptions = function _PaEnvironmentGetCommand_initOptions() {
-    this.options.unshift({
-        option: '-n, --name [name]'
-    });
-};
 export default new PaEnvironmentGetCommand();
 //# sourceMappingURL=environment-get.js.map

package/dist/m365/pp/commands/copilot/copilot-get.js

@@ -18,9 +18,6 @@ class PpCopilotGetCommand extends PowerPlatformCommand {
     get description() {
         return 'Get information about the specified copilot';
     }
-    alias() {
-        return [commands.CHATBOT_GET];
-    }
     constructor() {
         super();
         _PpCopilotGetCommand_instances.add(this);
@@ -30,7 +27,6 @@ class PpCopilotGetCommand extends PowerPlatformCommand {
         __classPrivateFieldGet(this, _PpCopilotGetCommand_instances, "m", _PpCopilotGetCommand_initOptionSets).call(this);
     }
     async commandAction(logger, args) {
-        await this.showDeprecationWarning(logger, commands.CHATBOT_GET, commands.COPILOT_GET);
         if (this.verbose) {
             await logger.logToStderr(`Retrieving copilot '${args.options.id || args.options.name}'...`);
         }

package/dist/m365/pp/commands/copilot/copilot-list.js

@@ -15,9 +15,6 @@ class PpCopilotListCommand extends PowerPlatformCommand {
     get description() {
         return 'Lists Microsoft Power Platform copilots in the specified Power Platform environment';
     }
-    alias() {
-        return [commands.CHATBOT_LIST];
-    }
     defaultProperties() {
         return ['name', 'botid', 'publishedOn', 'createdOn', 'botModifiedOn'];
     }
@@ -28,7 +25,6 @@ class PpCopilotListCommand extends PowerPlatformCommand {
         __classPrivateFieldGet(this, _PpCopilotListCommand_instances, "m", _PpCopilotListCommand_initOptions).call(this);
     }
     async commandAction(logger, args) {
-        await this.showDeprecationWarning(logger, commands.CHATBOT_LIST, commands.COPILOT_LIST);
         if (this.verbose) {
             await logger.logToStderr(`Retrieving list of copilots for environment '${args.options.environmentName}'.`);
         }

package/dist/m365/pp/commands/copilot/copilot-remove.js

@@ -18,9 +18,6 @@ class PpCopilotRemoveCommand extends PowerPlatformCommand {
     get description() {
         return 'Removes the specified copilot';
     }
-    alias() {
-        return [commands.CHATBOT_REMOVE];
-    }
     constructor() {
         super();
         _PpCopilotRemoveCommand_instances.add(this);
@@ -30,7 +27,6 @@ class PpCopilotRemoveCommand extends PowerPlatformCommand {
         __classPrivateFieldGet(this, _PpCopilotRemoveCommand_instances, "m", _PpCopilotRemoveCommand_initOptionSets).call(this);
     }
     async commandAction(logger, args) {
-        await this.showDeprecationWarning(logger, commands.CHATBOT_REMOVE, commands.COPILOT_REMOVE);
         if (this.verbose) {
             await logger.logToStderr(`Removing copilot '${args.options.id || args.options.name}'...`);
         }

package/dist/m365/pp/commands/environment/environment-get.js

@@ -1,13 +1,17 @@
-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 _PpEnvironmentGetCommand_instances, _PpEnvironmentGetCommand_initTelemetry, _PpEnvironmentGetCommand_initOptions;
+import { z } from 'zod';
+import { globalOptionsZod } from '../../../../Command.js';
 import request from '../../../../request.js';
 import { formatting } from '../../../../utils/formatting.js';
+import { zod } from '../../../../utils/zod.js';
 import PowerPlatformCommand from '../../../base/PowerPlatformCommand.js';
 import commands from '../../commands.js';
+const options = globalOptionsZod
+    .extend({
+    name: zod.alias('n', z.string().optional()),
+    default: z.boolean().optional(),
+    asAdmin: z.boolean().optional()
+})
+    .strict();
 class PpEnvironmentGetCommand extends PowerPlatformCommand {
     get name() {
         return commands.ENVIRONMENT_GET;
@@ -15,11 +19,14 @@ class PpEnvironmentGetCommand extends PowerPlatformCommand {
     get description() {
         return 'Gets information about the specified Power Platform environment';
     }
-    constructor() {
-        super();
-        _PpEnvironmentGetCommand_instances.add(this);
-        __classPrivateFieldGet(this, _PpEnvironmentGetCommand_instances, "m", _PpEnvironmentGetCommand_initTelemetry).call(this);
-        __classPrivateFieldGet(this, _PpEnvironmentGetCommand_instances, "m", _PpEnvironmentGetCommand_initOptions).call(this);
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => !!options.name !== !!options.default, {
+            message: `Specify either name or default, but not both.`
+        });
     }
     async commandAction(logger, args) {
         if (this.verbose) {
@@ -29,7 +36,7 @@ class PpEnvironmentGetCommand extends PowerPlatformCommand {
         if (args.options.asAdmin) {
             url += '/scopes/admin';
         }
-        const envName = args.options.name ? formatting.encodeQueryParameter(args.options.name) : '~Default';
+        const envName = args.options.default ? '~Default' : formatting.encodeQueryParameter(args.options.name);
         url += `/environments/${envName}?api-version=2020-10-01`;
         const requestOptions = {
             url: url,
@@ -42,19 +49,5 @@ class PpEnvironmentGetCommand extends PowerPlatformCommand {
         await logger.log(response);
     }
 }
-_PpEnvironmentGetCommand_instances = new WeakSet(), _PpEnvironmentGetCommand_initTelemetry = function _PpEnvironmentGetCommand_initTelemetry() {
-    this.telemetry.push((args) => {
-        Object.assign(this.telemetryProperties, {
-            name: typeof args.options.name !== 'undefined',
-            asAdmin: !!args.options.asAdmin
-        });
-    });
-}, _PpEnvironmentGetCommand_initOptions = function _PpEnvironmentGetCommand_initOptions() {
-    this.options.unshift({
-        option: '-n, --name [name]'
-    }, {
-        option: '--asAdmin'
-    });
-};
 export default new PpEnvironmentGetCommand();
 //# sourceMappingURL=environment-get.js.map

package/dist/m365/pp/commands.js

@@ -3,13 +3,6 @@ export default {
     AIBUILDERMODEL_GET: `${prefix} aibuildermodel get`,
     AIBUILDERMODEL_LIST: `${prefix} aibuildermodel list`,
     AIBUILDERMODEL_REMOVE: `${prefix} aibuildermodel remove`,
-    CARD_CLONE: `${prefix} card clone`,
-    CARD_GET: `${prefix} card get`,
-    CARD_LIST: `${prefix} card list`,
-    CARD_REMOVE: `${prefix} card remove`,
-    CHATBOT_GET: `${prefix} chatbot get`,
-    CHATBOT_LIST: `${prefix} chatbot list`,
-    CHATBOT_REMOVE: `${prefix} chatbot remove`,
     COPILOT_GET: `${prefix} copilot get`,
     COPILOT_LIST: `${prefix} copilot list`,
     COPILOT_REMOVE: `${prefix} copilot remove`,

package/dist/m365/spfx/commands/project/project-upgrade.js

@@ -1,20 +1,25 @@
-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 _SpfxProjectUpgradeCommand_instances, _a, _SpfxProjectUpgradeCommand_initTelemetry, _SpfxProjectUpgradeCommand_initOptions, _SpfxProjectUpgradeCommand_initValidators;
 import fs from 'fs';
 import os from 'os';
 import path from 'path';
 // uncomment to support upgrading to preview releases
 import { prerelease } from 'semver';
-import { CommandError } from '../../../../Command.js';
+import { z } from 'zod';
+import { CommandError, globalOptionsZod } from '../../../../Command.js';
 import { fsUtil } from '../../../../utils/fsUtil.js';
 import { packageManager } from '../../../../utils/packageManager.js';
+import { zod } from '../../../../utils/zod.js';
 import commands from '../../commands.js';
 import { BaseProjectCommand } from './base-project-command.js';
 import { FN017001_MISC_npm_dedupe } from './project-upgrade/rules/FN017001_MISC_npm_dedupe.js';
+const options = globalOptionsZod
+    .extend({
+    packageManager: z.enum(['npm', 'pnpm', 'yarn']).default('npm'),
+    preview: z.boolean().optional(),
+    toVersion: zod.alias('v', z.string().optional()),
+    shell: z.enum(['bash', 'powershell', 'cmd']).default('powershell'),
+    output: z.enum(['json', 'text', 'md', 'tour', 'csv', 'none']).optional()
+})
+    .strict();
 class SpfxProjectUpgradeCommand extends BaseProjectCommand {
     get name() {
         return commands.PROJECT_UPGRADE;
@@ -25,12 +30,14 @@ class SpfxProjectUpgradeCommand extends BaseProjectCommand {
     get allowedOutputs() {
         return ['json', 'text', 'md', 'tour'];
     }
+    get schema() {
+        return options;
+    }
     constructor() {
         super();
-        _SpfxProjectUpgradeCommand_instances.add(this);
         this.toVersion = '';
-        this.packageManager = 'npm';
-        this.shell = 'bash';
+        this.packageManager = '';
+        this.shell = '';
         this.allFindings = [];
         this.supportedVersions = [
             '1.0.0',
@@ -80,14 +87,11 @@ class SpfxProjectUpgradeCommand extends BaseProjectCommand {
             '1.21.1',
             '1.22.0-beta.1'
         ];
-        __classPrivateFieldGet(this, _SpfxProjectUpgradeCommand_instances, "m", _SpfxProjectUpgradeCommand_initTelemetry).call(this);
-        __classPrivateFieldGet(this, _SpfxProjectUpgradeCommand_instances, "m", _SpfxProjectUpgradeCommand_initOptions).call(this);
-        __classPrivateFieldGet(this, _SpfxProjectUpgradeCommand_instances, "m", _SpfxProjectUpgradeCommand_initValidators).call(this);
     }
     async commandAction(logger, args) {
         this.projectRootPath = this.getProjectRoot(process.cwd());
         if (this.projectRootPath === null) {
-            throw new CommandError(`Couldn't find project root folder`, _a.ERROR_NO_PROJECT_ROOT_FOLDER);
+            throw new CommandError(`Couldn't find project root folder`, SpfxProjectUpgradeCommand.ERROR_NO_PROJECT_ROOT_FOLDER);
         }
         this.toVersion = args.options.toVersion ? args.options.toVersion : this.supportedVersions[this.supportedVersions.length - 1];
         // uncomment to support upgrading to preview releases
@@ -101,21 +105,21 @@ class SpfxProjectUpgradeCommand extends BaseProjectCommand {
             this.toVersion = this.supportedVersions[this.supportedVersions.length - 2];
         }
         this.packageManager = args.options.packageManager || 'npm';
-        this.shell = args.options.shell || 'bash';
+        this.shell = args.options.shell || 'powershell';
         if (this.supportedVersions.indexOf(this.toVersion) < 0) {
-            throw new CommandError(`CLI for Microsoft 365 doesn't support upgrading SharePoint Framework projects to version ${this.toVersion}. Supported versions are ${this.supportedVersions.join(', ')}`, _a.ERROR_UNSUPPORTED_TO_VERSION);
+            throw new CommandError(`CLI for Microsoft 365 doesn't support upgrading SharePoint Framework projects to version ${this.toVersion}. Supported versions are ${this.supportedVersions.join(', ')}`, SpfxProjectUpgradeCommand.ERROR_UNSUPPORTED_TO_VERSION);
         }
         this.projectVersion = this.getProjectVersion();
         if (!this.projectVersion) {
-            throw new CommandError(`Unable to determine the version of the current SharePoint Framework project`, _a.ERROR_NO_VERSION);
+            throw new CommandError(`Unable to determine the version of the current SharePoint Framework project`, SpfxProjectUpgradeCommand.ERROR_NO_VERSION);
         }
         const pos = this.supportedVersions.indexOf(this.projectVersion);
         if (pos < 0) {
-            throw new CommandError(`CLI for Microsoft 365 doesn't support upgrading projects built using SharePoint Framework v${this.projectVersion}`, _a.ERROR_UNSUPPORTED_FROM_VERSION);
+            throw new CommandError(`CLI for Microsoft 365 doesn't support upgrading projects built using SharePoint Framework v${this.projectVersion}`, SpfxProjectUpgradeCommand.ERROR_UNSUPPORTED_FROM_VERSION);
         }
         const posTo = this.supportedVersions.indexOf(this.toVersion);
         if (pos > posTo) {
-            throw new CommandError('You cannot downgrade a project', _a.ERROR_NO_DOWNGRADE);
+            throw new CommandError('You cannot downgrade a project', SpfxProjectUpgradeCommand.ERROR_NO_DOWNGRADE);
         }
         if (pos === posTo) {
             await logger.log(`Project doesn't need to be upgraded`);
@@ -479,53 +483,6 @@ ${f.resolution}
         };
     }
 }
-_a = SpfxProjectUpgradeCommand, _SpfxProjectUpgradeCommand_instances = new WeakSet(), _SpfxProjectUpgradeCommand_initTelemetry = function _SpfxProjectUpgradeCommand_initTelemetry() {
-    this.telemetry.push((args) => {
-        Object.assign(this.telemetryProperties, {
-            toVersion: args.options.toVersion || this.supportedVersions[this.supportedVersions.length - 1],
-            packageManager: args.options.packageManager || 'npm',
-            shell: args.options.shell || 'bash',
-            preview: args.options.preview
-        });
-        // uncomment to support upgrading to preview releases
-        if (prerelease(this.telemetryProperties.toVersion) && !args.options.preview) {
-            this.telemetryProperties.toVersion = this.supportedVersions[this.supportedVersions.length - 2];
-        }
-    });
-}, _SpfxProjectUpgradeCommand_initOptions = function _SpfxProjectUpgradeCommand_initOptions() {
-    this.options.unshift({
-        option: '-v, --toVersion [toVersion]'
-    }, {
-        option: '--packageManager [packageManager]',
-        autocomplete: _a.packageManagers
-    }, {
-        option: '--shell [shell]',
-        autocomplete: _a.shells
-    }, {
-        option: '--preview'
-    });
-    this.options.forEach(o => {
-        if (o.option.indexOf('--output') > -1) {
-            o.autocomplete = this.allowedOutputs;
-        }
-    });
-}, _SpfxProjectUpgradeCommand_initValidators = function _SpfxProjectUpgradeCommand_initValidators() {
-    this.validators.push(async (args) => {
-        if (args.options.packageManager) {
-            if (_a.packageManagers.indexOf(args.options.packageManager) < 0) {
-                return `${args.options.packageManager} is not a supported package manager. Supported package managers are ${_a.packageManagers.join(', ')}`;
-            }
-        }
-        if (args.options.shell) {
-            if (_a.shells.indexOf(args.options.shell) < 0) {
-                return `${args.options.shell} is not a supported shell. Supported shells are ${_a.shells.join(', ')}`;
-            }
-        }
-        return true;
-    });
-};
-SpfxProjectUpgradeCommand.packageManagers = ['npm', 'pnpm', 'yarn'];
-SpfxProjectUpgradeCommand.shells = ['bash', 'powershell', 'cmd'];
 SpfxProjectUpgradeCommand.ERROR_NO_PROJECT_ROOT_FOLDER = 1;
 SpfxProjectUpgradeCommand.ERROR_UNSUPPORTED_TO_VERSION = 2;
 SpfxProjectUpgradeCommand.ERROR_NO_VERSION = 3;

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

@@ -33,17 +33,10 @@ class SpoCustomActionListCommand extends SpoCommand {
                 await logger.logToStderr('');
             }
             const customActions = await spo.getCustomActions(args.options.webUrl, args.options.scope);
-            if (customActions.length === 0) {
-                if (this.verbose) {
-                    await logger.logToStderr(`Custom actions not found`);
-                }
-            }
-            else {
-                if (args.options.output !== 'json') {
-                    customActions.forEach(a => a.Scope = this.humanizeScope(a.Scope));
-                }
-                await logger.log(customActions);
+            if (args.options.output !== 'json') {
+                customActions.forEach(a => a.Scope = this.humanizeScope(a.Scope));
             }
+            await logger.log(customActions);
         }
         catch (err) {
             this.handleRejectedPromise(err);

package/dist/m365/spo/commands/file/file-version-keep.js

@@ -0,0 +1,78 @@
+import commands from '../../commands.js';
+import SpoCommand from '../../../base/SpoCommand.js';
+import { globalOptionsZod } from '../../../../Command.js';
+import { z } from 'zod';
+import { zod } from '../../../../utils/zod.js';
+import { validation } from '../../../../utils/validation.js';
+import { urlUtil } from '../../../../utils/urlUtil.js';
+import request from '../../../../request.js';
+import { formatting } from '../../../../utils/formatting.js';
+import { odata } from '../../../../utils/odata.js';
+export 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.`
+    }))),
+    fileUrl: z.string().optional(),
+    fileId: zod.alias('i', z.string()
+        .refine(id => validation.isValidGuid(id), id => ({
+        message: `'${id}' is not a valid GUID.`
+    })).optional()),
+    label: z.string()
+})
+    .strict();
+class SpoFileVersionKeepCommand extends SpoCommand {
+    get name() {
+        return commands.FILE_VERSION_KEEP;
+    }
+    get description() {
+        return 'Ensure that a specific file version will never expire';
+    }
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => [options.fileUrl, options.fileId].filter(o => o !== undefined).length === 1, {
+            message: `Specify 'fileUrl' or 'fileId', but not both.`
+        });
+    }
+    async commandAction(logger, args) {
+        if (this.verbose) {
+            await logger.logToStderr(`Ensuring version '${args.options.label}' of file '${args.options.fileUrl || args.options.fileId}' at site '${args.options.webUrl}' will never expire...`);
+        }
+        try {
+            const baseApiUrl = this.getBaseApiUrl(args.options.webUrl, args.options.fileUrl, args.options.fileId);
+            const response = await odata.getAllItems(`${baseApiUrl}/versions?$filter=VersionLabel eq '${formatting.encodeQueryParameter(args.options.label)}'&$select=ID`);
+            if (response.length === 0) {
+                throw `Version with label '${args.options.label}' not found.`;
+            }
+            const requestExpirationOptions = {
+                url: `${baseApiUrl}/versions(${response[0].ID})/SetExpirationDate()`,
+                headers: {
+                    accept: 'application/json;odata=nometadata',
+                    'content-type': 'application/json'
+                },
+                responseType: 'json'
+            };
+            await request.post(requestExpirationOptions);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+    getBaseApiUrl(webUrl, fileUrl, fileId) {
+        let requestUrl;
+        if (fileUrl) {
+            const serverRelUrl = urlUtil.getServerRelativePath(webUrl, fileUrl);
+            requestUrl = `${webUrl}/_api/web/GetFileByServerRelativePath(DecodedUrl='${formatting.encodeQueryParameter(serverRelUrl)}')`;
+        }
+        else {
+            requestUrl = `${webUrl}/_api/web/GetFileById('${fileId}')`;
+        }
+        return requestUrl;
+    }
+}
+export default new SpoFileVersionKeepCommand();
+//# sourceMappingURL=file-version-keep.js.map

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

@@ -1,28 +1,42 @@
-import request from '../../../../request.js';
+import { z } from 'zod';
+import { zod } from '../../../../utils/zod.js';
+import { globalOptionsZod } from '../../../../Command.js';
+import { validation } from '../../../../utils/validation.js';
 import { spo } from '../../../../utils/spo.js';
 import SpoCommand from '../../../base/SpoCommand.js';
 import commands from '../../commands.js';
+import { odata } from '../../../../utils/odata.js';
+import { urlUtil } from '../../../../utils/urlUtil.js';
+const options = globalOptionsZod
+    .extend({
+    url: zod.alias('u', z.string()
+        .refine(url => validation.isValidSharePointUrl(url) === true, url => ({
+        message: `'${url}' is not a valid SharePoint Online site URL.`
+    })))
+})
+    .strict();
 class SpoHomeSiteGetCommand extends SpoCommand {
     get name() {
         return commands.HOMESITE_GET;
     }
     get description() {
-        return 'Gets information about the Home Site';
+        return 'Gets information about a home site';
     }
-    async commandAction(logger) {
+    get schema() {
+        return options;
+    }
+    async commandAction(logger, args) {
         try {
-            const spoUrl = await spo.getSpoUrl(logger, this.debug);
-            const requestOptions = {
-                url: `${spoUrl}/_api/SP.SPHSite/Details`,
-                headers: {
-                    accept: 'application/json;odata=nometadata'
-                },
-                responseType: 'json'
-            };
-            const res = await request.get(requestOptions);
-            if (!res["odata.null"]) {
-                await logger.log(res);
+            const spoAdminUrl = await spo.getSpoAdminUrl(logger, this.verbose);
+            if (this.verbose) {
+                await logger.log(`Retrieving home sites...`);
+            }
+            const homeSites = await odata.getAllItems(`${spoAdminUrl}/_api/SPO.Tenant/GetTargetedSitesDetails`);
+            const homeSite = homeSites.find(hs => urlUtil.removeTrailingSlashes(hs.Url).toLowerCase() === urlUtil.removeTrailingSlashes(args.options.url).toLowerCase());
+            if (homeSite === undefined) {
+                throw `Home site with URL '${args.options.url}' not found.`;
             }
+            await logger.log(homeSite);
         }
         catch (err) {
             this.handleRejectedODataJsonPromise(err);

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

@@ -9,27 +9,16 @@ class SpoHomeSiteListCommand extends SpoCommand {
     get description() {
         return 'Lists all home sites';
     }
-    alias() {
-        return [commands.TENANT_HOMESITE_LIST];
-    }
     defaultProperties() {
         return ['Url', 'Title'];
     }
     async commandAction(logger) {
-        await this.showDeprecationWarning(logger, commands.TENANT_HOMESITE_LIST, commands.HOMESITE_LIST);
         try {
             const spoAdminUrl = await spo.getSpoAdminUrl(logger, this.verbose);
-            const requestOptions = {
-                url: `${spoAdminUrl}/_api/SPO.Tenant/GetTargetedSitesDetails`,
-                headers: {
-                    accept: 'application/json;odata=nometadata'
-                },
-                responseType: 'json'
-            };
             if (this.verbose) {
                 await logger.logToStderr(`Retrieving all home sites...`);
             }
-            const res = await odata.getAllItems(requestOptions);
+            const res = await odata.getAllItems(`${spoAdminUrl}/_api/SPO.Tenant/GetTargetedSitesDetails`);
             await logger.log(res);
         }
         catch (err) {