@pnp/cli-microsoft365 12.0.0-beta.0be7d8d → 12.0.0-beta.1752794

package/dist/Auth.js

@@ -262,7 +262,7 @@ export class Auth {
         return {
             auth: authConfig,
             cache: {
-                cachePlugin: msalCachePlugin
+                cachePlugin: await msalCachePlugin.getCachePlugin()
             },
             system: {
                 loggerOptions: {
@@ -735,8 +735,7 @@ export class Auth {
         await allConnectionsStorage.remove();
         // we need to manually clear MSAL cache, because MSAL doesn't have support
         // for logging out when using cert-based auth
-        const msalCache = this.getMsalCacheStorage();
-        await msalCache.remove();
+        await msalCachePlugin.clearMsalCache();
     }
     async removeConnectionInfo(connection, logger, debug) {
         const allConnections = await this.getAllConnections();
@@ -769,9 +768,6 @@ export class Auth {
     getConnectionStorage() {
         return new FileTokenStorage(FileTokenStorage.connectionInfoFilePath());
     }
-    getMsalCacheStorage() {
-        return new FileTokenStorage(FileTokenStorage.msalCacheFilePath());
-    }
     getAllConnectionsStorage() {
         return new FileTokenStorage(FileTokenStorage.allConnectionsFilePath());
     }

package/dist/auth/FileTokenStorage.js

@@ -2,9 +2,6 @@ import fs from 'fs';
 import os from 'os';
 import path from 'path';
 export class FileTokenStorage {
-    static msalCacheFilePath() {
-        return path.join(os.homedir(), '.cli-m365-msal.json');
-    }
     static connectionInfoFilePath() {
         return path.join(os.homedir(), '.cli-m365-connection.json');
     }

package/dist/auth/msalCachePlugin.js

@@ -1,29 +1,218 @@
-import { FileTokenStorage } from './FileTokenStorage.js';
-class MsalCachePlugin {
-    constructor() {
-        this.fileTokenStorage = new FileTokenStorage(FileTokenStorage.msalCacheFilePath());
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+import { lock } from 'proper-lockfile';
+const legacyCachePath = path.join(os.homedir(), '.cli-m365-msal.json');
+const fallbackCachePath = path.join(os.homedir(), '.cli-m365-msal-cache.json');
+const lockRetryCount = 500;
+const lockRetryDelay = 100;
+const staleLockThreshold = 10000;
+const persistenceConfiguration = {
+    cachePath: fallbackCachePath,
+    serviceName: 'cli-microsoft365',
+    accountName: 'msal-cache',
+    usePlaintextFileOnLinux: true
+};
+export const fileLock = { lock };
+let _initPromise;
+// Fallback ICachePlugin that stores tokens as plain JSON on disk.
+// @azure/msal-node-extensions ships a usePlaintextFileOnLinux option
+// for Linux systems without libsecret, but the package's barrel export
+// eagerly loads LibSecretPersistence which does `import keytar` at the
+// top level. When libsecret is missing, the entire dynamic import of
+// the package fails before any fallback logic can run. This class
+// provides equivalent file-based persistence without depending on the
+// package at all.
+// See: https://github.com/AzureAD/microsoft-authentication-library-for-js/issues/7170
+class FileCachePlugin {
+    constructor(cachePath) {
+        this.cachePath = cachePath;
     }
     async beforeCacheAccess(tokenCacheContext) {
+        await this.acquireLock();
         try {
-            const data = await this.fileTokenStorage.get();
-            tokenCacheContext.tokenCache.deserialize(data);
+            if (fs.existsSync(this.cachePath)) {
+                const data = fs.readFileSync(this.cachePath, 'utf8');
+                tokenCacheContext.tokenCache.deserialize(data);
+            }
         }
         catch {
             // Do nothing
         }
     }
     async afterCacheAccess(tokenCacheContext) {
-        if (!tokenCacheContext.cacheHasChanged) {
-            return;
-        }
         try {
-            await this.fileTokenStorage.set(tokenCacheContext.tokenCache.serialize());
+            if (tokenCacheContext.cacheHasChanged) {
+                if (fs.existsSync(this.cachePath)) {
+                    fs.chmodSync(this.cachePath, 0o600);
+                }
+                fs.writeFileSync(this.cachePath, tokenCacheContext.tokenCache.serialize(), { encoding: 'utf8', mode: 0o600 });
+            }
         }
         catch {
             // Do nothing
         }
+        finally {
+            await this.releaseLock();
+        }
+    }
+    async clearCache() {
+        await this.acquireLock();
+        try {
+            removeFile(this.cachePath);
+        }
+        finally {
+            await this.releaseLock();
+        }
+    }
+    async acquireLock() {
+        this.releaseCacheLock = await msalCachePlugin.acquireFileLock(this.cachePath);
+    }
+    async releaseLock() {
+        if (this.releaseCacheLock === undefined) {
+            return;
+        }
+        const releaseCacheLock = this.releaseCacheLock;
+        this.releaseCacheLock = undefined;
+        await releaseCacheLock();
+    }
+}
+class LockingCachePlugin {
+    constructor(plugin, lockPath) {
+        this.plugin = plugin;
+        this.lockPath = lockPath;
+    }
+    async beforeCacheAccess(tokenCacheContext) {
+        this.releaseCacheLock = await msalCachePlugin.acquireFileLock(this.lockPath);
+        try {
+            await this.plugin.beforeCacheAccess(tokenCacheContext);
+        }
+        catch (err) {
+            await this.releaseLock();
+            throw err;
+        }
+    }
+    async afterCacheAccess(tokenCacheContext) {
+        try {
+            await this.plugin.afterCacheAccess(tokenCacheContext);
+        }
+        finally {
+            await this.releaseLock();
+        }
+    }
+    async clearCache(clearCache) {
+        this.releaseCacheLock = await msalCachePlugin.acquireFileLock(this.lockPath);
+        try {
+            await clearCache();
+        }
+        finally {
+            await this.releaseLock();
+        }
+    }
+    async releaseLock() {
+        if (this.releaseCacheLock === undefined) {
+            return;
+        }
+        const releaseCacheLock = this.releaseCacheLock;
+        this.releaseCacheLock = undefined;
+        await releaseCacheLock();
     }
 }
-const msalCachePlugin = new MsalCachePlugin();
-export { msalCachePlugin };
+function removeFile(filePath) {
+    try {
+        fs.unlinkSync(filePath);
+    }
+    catch (err) {
+        if (err.code !== 'ENOENT') {
+            throw err;
+        }
+    }
+}
+export const msalCachePlugin = {
+    async acquireFileLock(cachePath) {
+        return await fileLock.lock(cachePath, {
+            lockfilePath: `${cachePath}.lockfile`,
+            realpath: false,
+            stale: staleLockThreshold,
+            update: staleLockThreshold / 2,
+            retries: {
+                retries: lockRetryCount,
+                factor: 1,
+                minTimeout: lockRetryDelay,
+                maxTimeout: lockRetryDelay,
+                randomize: false
+            }
+        });
+    },
+    async importMsalExtensions() {
+        return await import('@azure/msal-node-extensions');
+    },
+    async createNativePersistence() {
+        const { DataProtectionScope, PersistenceCachePlugin, PersistenceCreator } = await msalCachePlugin.importMsalExtensions();
+        const persistence = await PersistenceCreator.createPersistence({
+            ...persistenceConfiguration,
+            dataProtectionScope: DataProtectionScope.CurrentUser
+        });
+        const plugin = new LockingCachePlugin(new PersistenceCachePlugin(persistence), `${persistence.getFilePath()}.cli-m365`);
+        return {
+            plugin,
+            clearCache: async () => { await plugin.clearCache(async () => { await persistence.delete(); }); },
+            isFileFallback: false
+        };
+    },
+    createFileFallback() {
+        const plugin = new FileCachePlugin(persistenceConfiguration.cachePath);
+        return {
+            plugin,
+            clearCache: async () => { await plugin.clearCache(); },
+            isFileFallback: true
+        };
+    },
+    removeLegacyCache() {
+        removeFile(legacyCachePath);
+    },
+    async getCachePlugin() {
+        _initPromise ?? (_initPromise = (async () => {
+            msalCachePlugin.removeLegacyCache();
+            try {
+                return await msalCachePlugin.createNativePersistence();
+            }
+            catch (err) {
+                // Fall back to file-based cache only on Linux where libsecret
+                // may not be installed. On Windows (DPAPI) and macOS (Keychain)
+                // native persistence should always work.
+                if (process.platform === 'linux') {
+                    return msalCachePlugin.createFileFallback();
+                }
+                throw err;
+            }
+        })());
+        const { plugin } = await _initPromise;
+        return plugin;
+    },
+    async clearMsalCache() {
+        _initPromise ?? (_initPromise = (async () => {
+            msalCachePlugin.removeLegacyCache();
+            try {
+                return await msalCachePlugin.createNativePersistence();
+            }
+            catch (err) {
+                if (process.platform === 'linux') {
+                    return msalCachePlugin.createFileFallback();
+                }
+                throw err;
+            }
+        })());
+        const { clearCache, isFileFallback } = await _initPromise;
+        await clearCache();
+        // Also remove the file-based fallback cache to ensure no tokens
+        // remain if the machine previously used file-based persistence
+        if (!isFileFallback) {
+            await msalCachePlugin.createFileFallback().clearCache();
+        }
+    },
+    resetForTesting() {
+        _initPromise = undefined;
+    }
+};
 //# sourceMappingURL=msalCachePlugin.js.map

package/dist/googleAnalytics.js

@@ -0,0 +1,96 @@
+import Axios from 'axios';
+import Configstore from 'configstore';
+import crypto from 'crypto';
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+import url from 'url';
+import config from './config.js';
+import { app } from './utils/app.js';
+const measurementId = 'G-4BNT8MQCYT';
+const apiSecret = 'mm_3WD_TRuO-9MKsuZnhDQ';
+const endpoint = 'https://www.google-analytics.com/mp/collect';
+const clientIdSetting = 'telemetryClientId';
+const requestTimeout = 3000;
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url));
+const commonProperties = {
+    version: `${app.packageJson().version}${fs.existsSync(path.join(__dirname, `..${path.sep}src`)) ? '-dev' : ''}`,
+    node: process.version,
+    os: os.platform(),
+    env: process.env.CLIMICROSOFT365_ENV ?? '',
+    ci: Boolean(process.env.CI).toString()
+};
+function getClientId() {
+    const store = new Configstore(config.configstoreName);
+    let clientId = store.get(clientIdSetting);
+    if (!clientId) {
+        clientId = crypto.randomUUID();
+        store.set(clientIdSetting, clientId);
+    }
+    return clientId;
+}
+function getSessionId(sessionId) {
+    return parseInt(crypto.createHash('sha256').update(sessionId).digest('hex').substring(0, 12), 16);
+}
+function toEventValue(value) {
+    if (typeof value === 'number') {
+        return value;
+    }
+    return String(value);
+}
+function getEvents(commandName, properties, context) {
+    const sessionId = getSessionId(context.sessionId);
+    const eventProperties = Object.entries(properties).reduce((result, [name, value]) => {
+        if (typeof value !== 'undefined') {
+            result[name] = toEventValue(value);
+        }
+        return result;
+    }, {});
+    return [{
+            name: 'command_used',
+            params: {
+                ['command_name']: commandName,
+                ...commonProperties,
+                shell: context.shell,
+                ...eventProperties,
+                ['session_id']: sessionId,
+                ['engagement_time_msec']: 1
+            }
+        }];
+}
+async function sendEvents(events) {
+    const clientId = getClientId();
+    const response = await Axios.post(`${endpoint}?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
+        ['client_id']: clientId,
+        events
+    }, {
+        headers: {
+            'Content-Type': 'application/json'
+        },
+        timeout: requestTimeout,
+        validateStatus: () => true
+    });
+    if (response.status < 200 || response.status >= 300) {
+        throw new Error(`Google Analytics returned ${response.status}`);
+    }
+}
+export const googleAnalytics = {
+    commonProperties,
+    trackEvent: async (commandName, properties, context) => {
+        await sendEvents(getEvents(commandName, properties, context));
+    },
+    trackException: async (exception, context) => {
+        const description = exception instanceof Error ? exception.message : String(exception);
+        await sendEvents([{
+                name: 'exception',
+                params: {
+                    description: description.substring(0, 100),
+                    ...commonProperties,
+                    shell: context.shell,
+                    ['session_id']: getSessionId(context.sessionId),
+                    ['engagement_time_msec']: 1
+                }
+            }]);
+    }
+};
+//# sourceMappingURL=googleAnalytics.js.map

package/dist/m365/commands/logout.js

@@ -16,7 +16,6 @@ class LogoutCommand extends Command {
         if (this.verbose) {
             await logger.logToStderr('Logging out from Microsoft 365...');
         }
-        const deactivate = () => auth.connection.deactivate();
         try {
             await auth.clearConnectionInfo();
         }
@@ -24,10 +23,9 @@ class LogoutCommand extends Command {
             if (this.debug) {
                 await logger.logToStderr(new CommandError(error));
             }
+            throw new CommandError(error);
         }
-        finally {
-            deactivate();
-        }
+        auth.connection.deactivate();
     }
     async action(logger, args) {
         try {

package/dist/m365/entra/commands/m365group/m365group-remove.js

@@ -49,7 +49,7 @@ class EntraM365GroupRemoveCommand extends GraphCommand {
                 const spoAdminUrl = await spo.getSpoAdminUrl(logger, this.debug);
                 // Delete the Microsoft 365 group site. This operation will also delete the group.
                 await this.deleteM365GroupSite(logger, siteUrl, spoAdminUrl);
-                if (args.options.skipRecycleBin) {
+                if (args.options.permanent) {
                     await this.deleteM365GroupFromRecycleBin(logger, groupId);
                     await this.deleteSiteFromRecycleBin(logger, siteUrl, spoAdminUrl);
                 }
@@ -169,7 +169,7 @@ _EntraM365GroupRemoveCommand_instances = new WeakSet(), _EntraM365GroupRemoveCom
     this.telemetry.push((args) => {
         Object.assign(this.telemetryProperties, {
             force: (!(!args.options.force)).toString(),
-            skipRecycleBin: args.options.skipRecycleBin
+            permanent: !!args.options.permanent
         });
     });
 }, _EntraM365GroupRemoveCommand_initOptions = function _EntraM365GroupRemoveCommand_initOptions() {
@@ -180,7 +180,7 @@ _EntraM365GroupRemoveCommand_instances = new WeakSet(), _EntraM365GroupRemoveCom
     }, {
         option: '-f, --force'
     }, {
-        option: '--skipRecycleBin'
+        option: '--permanent'
     });
 }, _EntraM365GroupRemoveCommand_initValidators = function _EntraM365GroupRemoveCommand_initValidators() {
     this.validators.push(async (args) => {
@@ -193,6 +193,7 @@ _EntraM365GroupRemoveCommand_instances = new WeakSet(), _EntraM365GroupRemoveCom
     this.optionSets.push({ options: ['id', 'displayName'] });
 }, _EntraM365GroupRemoveCommand_initTypes = function _EntraM365GroupRemoveCommand_initTypes() {
     this.types.string.push('id', 'displayName');
+    this.types.boolean.push('permanent');
 };
 EntraM365GroupRemoveCommand.maxRetries = 10;
 export default new EntraM365GroupRemoveCommand();

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

@@ -11,7 +11,7 @@ export const options = z.strictObject({
     name: z.string().optional().alias('n'),
     containerTypeId: z.uuid().optional(),
     containerTypeName: z.string().optional(),
-    recycle: z.boolean().optional(),
+    permanent: z.boolean().optional(),
     force: z.boolean().optional().alias('f')
 });
 class SpeContainerRemoveCommand extends GraphCommand {
@@ -46,7 +46,7 @@ class SpeContainerRemoveCommand extends GraphCommand {
     }
     async commandAction(logger, args) {
         if (!args.options.force) {
-            const result = await cli.promptForConfirmation({ message: `Are you sure you want to remove container '${args.options.id || args.options.name}'${!args.options.recycle ? ' permanently' : ''}?` });
+            const result = await cli.promptForConfirmation({ message: `Are you sure you want to ${args.options.permanent ? 'permanently remove' : 'recycle'} container '${args.options.id || args.options.name}'?` });
             if (!result) {
                 return;
             }
@@ -63,13 +63,12 @@ class SpeContainerRemoveCommand extends GraphCommand {
                 },
                 responseType: 'json'
             };
-            if (args.options.recycle) {
-                await request.delete(requestOptions);
+            if (args.options.permanent) {
+                requestOptions.url += '/permanentDelete';
+                await request.post(requestOptions);
                 return;
             }
-            // Container should be permanently deleted
-            requestOptions.url += '/permanentDelete';
-            await request.post(requestOptions);
+            await request.delete(requestOptions);
         }
         catch (err) {
             this.handleRejectedODataJsonPromise(err);

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

@@ -1,17 +1,34 @@
-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 _SpoAppAddCommand_instances, _SpoAppAddCommand_initTelemetry, _SpoAppAddCommand_initOptions, _SpoAppAddCommand_initValidators;
 import fs from 'fs';
 import path from 'path';
+import { z } from 'zod';
 import { cli } from '../../../../cli/cli.js';
+import { globalOptionsZod } from '../../../../Command.js';
 import request from '../../../../request.js';
 import { spo } from '../../../../utils/spo.js';
 import { validation } from '../../../../utils/validation.js';
+import { zod } from '../../../../utils/zod.js';
 import commands from '../../commands.js';
 import { SpoAppBaseCommand } from './SpoAppBaseCommand.js';
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    filePath: z.string()
+        .refine(filePath => fs.existsSync(path.resolve(filePath)), {
+        error: e => `File '${path.resolve(e.input)}' not found`,
+        abort: true
+    })
+        .refine(filePath => !fs.lstatSync(path.resolve(filePath)).isDirectory(), {
+        error: e => `Path '${path.resolve(e.input)}' points to a directory`
+    })
+        .alias('p'),
+    overwrite: z.boolean().optional(),
+    appCatalogScope: zod.coercedEnum({ tenant: 'tenant', sitecollection: 'sitecollection' }).optional().alias('s'),
+    appCatalogUrl: z.string()
+        .refine(url => validation.isValidSharePointUrl(url) === true, {
+        error: e => `'${e.input}' is not a valid SharePoint Online site URL.`
+    })
+        .optional()
+        .alias('u')
+});
 class SpoAppAddCommand extends SpoAppBaseCommand {
     get name() {
         return commands.APP_ADD;
@@ -19,13 +36,18 @@ class SpoAppAddCommand extends SpoAppBaseCommand {
     get description() {
         return 'Adds an app to the specified SharePoint Online app catalog';
     }
-    constructor() {
-        super();
-        _SpoAppAddCommand_instances.add(this);
-        this.appCatalogScopeOptions = ['tenant', 'sitecollection'];
-        __classPrivateFieldGet(this, _SpoAppAddCommand_instances, "m", _SpoAppAddCommand_initTelemetry).call(this);
-        __classPrivateFieldGet(this, _SpoAppAddCommand_instances, "m", _SpoAppAddCommand_initOptions).call(this);
-        __classPrivateFieldGet(this, _SpoAppAddCommand_instances, "m", _SpoAppAddCommand_initValidators).call(this);
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(opts => opts.appCatalogScope !== 'sitecollection' || opts.appCatalogUrl !== undefined, {
+            error: 'You must specify appCatalogUrl when appCatalogScope is sitecollection',
+            path: ['appCatalogUrl'],
+            params: {
+                customCode: 'required'
+            }
+        });
     }
     async commandAction(logger, args) {
         const scope = (args.options.appCatalogScope) ? args.options.appCatalogScope.toLowerCase() : 'tenant';
@@ -60,48 +82,5 @@ class SpoAppAddCommand extends SpoAppBaseCommand {
         }
     }
 }
-_SpoAppAddCommand_instances = new WeakSet(), _SpoAppAddCommand_initTelemetry = function _SpoAppAddCommand_initTelemetry() {
-    this.telemetry.push((args) => {
-        Object.assign(this.telemetryProperties, {
-            overwrite: !!args.options.overwrite,
-            appCatalogScope: args.options.appCatalogScope || 'tenant',
-            appCatalogUrl: typeof args.options.appCatalogUrl !== 'undefined'
-        });
-    });
-}, _SpoAppAddCommand_initOptions = function _SpoAppAddCommand_initOptions() {
-    this.options.unshift({
-        option: '-p, --filePath <filePath>'
-    }, {
-        option: '-s, --appCatalogScope [appCatalogScope]',
-        autocomplete: this.appCatalogScopeOptions
-    }, {
-        option: '-u, --appCatalogUrl [appCatalogUrl]'
-    }, {
-        option: '--overwrite [overwrite]'
-    });
-}, _SpoAppAddCommand_initValidators = function _SpoAppAddCommand_initValidators() {
-    this.validators.push(async (args) => {
-        if (args.options.appCatalogScope) {
-            const appCatalogScope = args.options.appCatalogScope.toLowerCase();
-            if (this.appCatalogScopeOptions.indexOf(appCatalogScope) === -1) {
-                return `${args.options.appCatalogScope} is not a valid appCatalogScope. Allowed values are: ${this.appCatalogScopeOptions.join(', ')}`;
-            }
-            if (appCatalogScope === 'sitecollection' && !args.options.appCatalogUrl) {
-                return `You must specify appCatalogUrl when appCatalogScope is sitecollection`;
-            }
-        }
-        const fullPath = path.resolve(args.options.filePath);
-        if (!fs.existsSync(fullPath)) {
-            return `File '${fullPath}' not found`;
-        }
-        if (fs.lstatSync(fullPath).isDirectory()) {
-            return `Path '${fullPath}' points to a directory`;
-        }
-        if (args.options.appCatalogUrl) {
-            return validation.isValidSharePointUrl(args.options.appCatalogUrl);
-        }
-        return true;
-    });
-};
 export default new SpoAppAddCommand();
 //# sourceMappingURL=app-add.js.map