@pnp/cli-microsoft365 5.9.0-beta.bc3200c → 5.9.0-beta.fd24b4e

package/dist/utils/cache.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cache = void 0;
+const fs = require("fs");
+const os = require("os");
+const path = require("path");
+const config_1 = require("../config");
+const cacheFolderPath = path.join(os.tmpdir(), config_1.default.configstoreName.replace('config', 'cache'));
+const mkdirOptions = { mode: 0o0700, recursive: true };
+exports.cache = {
+    cacheFolderPath: cacheFolderPath,
+    getValue(key) {
+        this.clearExpired();
+        try {
+            const cacheFilePath = path.join(cacheFolderPath, key);
+            if (!fs.existsSync(cacheFilePath)) {
+                return undefined;
+            }
+            return fs.readFileSync(cacheFilePath, 'utf8');
+        }
+        catch (_a) {
+            return undefined;
+        }
+    },
+    setValue(key, value) {
+        this.clearExpired();
+        try {
+            fs.mkdirSync(cacheFolderPath, mkdirOptions);
+            const cacheFilePath = path.join(cacheFolderPath, key);
+            // we don't need to wait for the file to be written
+            // eslint-disable-next-line @typescript-eslint/no-empty-function
+            fs.writeFile(cacheFilePath, value, () => { });
+        }
+        catch (_a) { }
+    },
+    clearExpired(cb) {
+        // we don't need to wait for this to complete
+        // even if it stops meanwhile, it will be picked up next time
+        fs.readdir(cacheFolderPath, (err, files) => {
+            if (err) {
+                if (cb) {
+                    cb();
+                }
+                return;
+            }
+            const numFiles = files.length;
+            if (numFiles === 0) {
+                if (cb) {
+                    cb();
+                }
+                return;
+            }
+            files.forEach((file, index) => {
+                fs.stat(path.join(cacheFolderPath, file), (err, stats) => {
+                    if (err || stats.isDirectory()) {
+                        if (cb && index === numFiles - 1) {
+                            cb();
+                        }
+                        return;
+                    }
+                    // remove files that haven't been accessed in the last 24 hours
+                    if (stats.atime.getTime() < Date.now() - 24 * 60 * 60 * 1000) {
+                        // we don't need to wait for the file to be deleted
+                        // eslint-disable-next-line @typescript-eslint/no-empty-function
+                        fs.unlink(path.join(cacheFolderPath, file), () => {
+                            if (cb && index === numFiles - 1) {
+                                cb();
+                            }
+                        });
+                    }
+                    else {
+                        if (cb && index === numFiles - 1) {
+                            cb();
+                        }
+                    }
+                });
+            });
+        });
+    }
+};
+//# sourceMappingURL=cache.js.map

package/dist/utils/pid.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pid = void 0;
+const os = require("os");
+const fs = require("fs");
+const child_process_1 = require("child_process");
+const cache_1 = require("./cache");
+function getProcessNameOnMacOs(pid) {
+    const stdout = (0, child_process_1.execSync)(`ps -o comm= ${pid}`, { encoding: 'utf8' });
+    return stdout.trim();
+}
+function getProcessNameOnLinux(pid) {
+    if (!fs.existsSync(`/proc/${pid}/stat`)) {
+        return undefined;
+    }
+    const stat = fs.readFileSync(`/proc/${pid}/stat`, 'utf8');
+    const start = stat.indexOf('(');
+    const procName = stat.substring(start + 1, stat.indexOf(')') - start);
+    return procName;
+}
+function getProcessNameOnWindows(pid) {
+    const stdout = (0, child_process_1.execSync)(`wmic PROCESS where ProcessId=${pid} get Caption | find /V "Caption"`, { encoding: 'utf8' });
+    return stdout.trim();
+}
+exports.pid = {
+    getProcessName(pid) {
+        let processName = cache_1.cache.getValue(pid.toString());
+        if (processName) {
+            return processName;
+        }
+        let getPidName = undefined;
+        const platform = os.platform();
+        if (platform.indexOf('win') === 0) {
+            getPidName = getProcessNameOnWindows;
+        }
+        if (platform === 'darwin') {
+            getPidName = getProcessNameOnMacOs;
+        }
+        if (platform === 'linux') {
+            getPidName = getProcessNameOnLinux;
+        }
+        if (getPidName) {
+            try {
+                processName = getPidName(pid);
+                if (processName) {
+                    cache_1.cache.setValue(pid.toString(), processName);
+                }
+                return processName;
+            }
+            catch (_a) {
+                return undefined;
+            }
+        }
+        return undefined;
+    }
+};
+//# sourceMappingURL=pid.js.map

package/dist/utils/powerPlatform.js

@@ -0,0 +1,42 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.powerPlatform = void 0;
+const request_1 = require("../request");
+const powerPlatformResource = 'https://api.bap.microsoft.com';
+exports.powerPlatform = {
+    getDynamicsInstanceApiUrl(environment, asAdmin) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let url = '';
+            if (asAdmin) {
+                url = `${powerPlatformResource}/providers/Microsoft.BusinessAppPlatform/scopes/admin/environments/${encodeURIComponent(environment)}`;
+            }
+            else {
+                url = `${powerPlatformResource}/providers/Microsoft.BusinessAppPlatform/environments/${encodeURIComponent(environment)}`;
+            }
+            const requestOptions = {
+                url: `${url}?api-version=2020-10-01&$select=properties.linkedEnvironmentMetadata.instanceApiUrl`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            try {
+                const response = yield request_1.default.get(requestOptions);
+                return Promise.resolve(response.properties.linkedEnvironmentMetadata.instanceApiUrl);
+            }
+            catch (ex) {
+                throw Error(`The environment '${environment}' could not be retrieved. See the inner exception for more details: ${ex.message}`);
+            }
+        });
+    }
+};
+//# sourceMappingURL=powerPlatform.js.map

package/docs/docs/cmd/pp/dataverse/dataverse-table-list.md

@@ -0,0 +1,33 @@
+# pp dataverse table list
+
+Lists dataverse tables in a given environment
+
+## Usage
+
+```sh
+pp dataverse table list [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+The name of the environment to list all tables for
+
+`-a, --asAdmin`
+Set, to retrieve the dataverse tables as admin for environments you are not a member of.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List all tables for the given environment
+
+```sh
+m365 pp dataverse table list -e "Default-2ca3eaa5-140f-4175-8261-3272edf9f339"
+```
+
+List all tables for the given environment as Admin
+
+```sh
+m365 pp dataverse table list -e "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --asAdmin
+```

package/docs/docs/cmd/pp/solution/solution-list.md

@@ -0,0 +1,33 @@
+# pp solution list
+
+Lists solutions in a given environment.
+
+## Usage
+
+```sh
+m365 pp solution list [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+The name of the environment
+
+`-a, --asAdmin`
+Run the command as admin for environments you do not have explicitly assigned permissions to.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List all solutions in a specific environment
+
+```sh
+m365 pp solution list --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339"
+```
+
+List all solutions in a specific environment as Admin
+
+```sh
+m365 pp solution list --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --asAdmin
+```

package/docs/docs/cmd/pp/tenant/tenant-settings-list.md

@@ -0,0 +1,26 @@
+# pp tenant settings list
+
+Lists the global Power Platform tenant settings
+
+## Usage
+
+```sh
+m365 pp tenant settings list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! attention
+    This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
+
+## Examples
+
+Lists the global Power Platform settings of the tenant
+
+```sh
+m365 pp tenant settings list
+```

package/docs/docs/cmd/spfx/spfx-doctor.md

@@ -13,6 +13,9 @@ m365 spfx doctor [options]
 `-e, --env [env]`
 : Version of SharePoint for which to check compatibility: `sp2016|sp2019|spo`
 
+`-v, --spfxVersion [spfxVersion]`
+: Version of the SharePoint Framework Yeoman generator to check compatibility for without `v`, eg. `1.11.0`
+
 `-h, --help`
 : output usage information
 
@@ -48,7 +51,7 @@ Next to verifying the readiness of your environment to use a particular version
 
 ## Examples
 
-Verify if your environment meets the requirements to work with the SharePoint Framework
+Verify if your environment meets the requirements to work with SharePoint Framework based on the globally installed version of the SharePoint Framework Yeoman generator or the current project
 
 ```sh
 m365 spfx doctor --output text
@@ -59,3 +62,9 @@ Verify if your environment meets the requirements to work with the SharePoint Fr
 ```sh
 m365 spfx doctor --env sp2019 --output text
 ```
+
+Verify if your environment meets the requirements to work with SharePoint Framework v1.11.0
+
+```sh
+m365 spfx doctor --spfxVersion 1.11.0 --output text
+```

package/docs/docs/cmd/spo/file/file-roleassignment-add.md

@@ -0,0 +1,57 @@
+# spo file roleassignment add
+
+Adds a role assignment to the specified file.
+
+## Usage
+
+```sh
+m365 spo file roleassignment add [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the file is located
+
+`--fileUrl [fileUrl]`
+: The server-relative URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
+
+`i, --fileId [fileId]`
+: The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
+
+`--principalId [principalId]`
+: The SharePoint Id of the principal. It may be either a user id or group id to add a role assignment for. Specify either upn, groupName or principalId.
+
+`--upn [upn]`
+: upn/email of user to assign role to. Specify either upn, groupName or principalId.
+
+`--groupName [groupName]`
+: The group name of Azure AD or SharePoint group. Specify either upn, groupName or principalId.
+
+`--roleDefinitionId [roleDefinitionId]`
+: ID of role definition. Specify either roleDefinitionId or roleDefinitionName but not both
+
+`--roleDefinitionName [roleDefinitionName]`
+: Enter the name of a role definition, like 'Contribute', 'Read', etc. Specify either roleDefinitionId or roleDefinitionName but not both
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Adds a role assignment to a file with a specified id. It will use a principal id and a specific role definition id.
+
+```sh
+m365 spo file roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --principalId 11 --roleDefinitionId 1073741829
+```
+
+Adds a role assignment to a file with a specified site-relative URL for a specific upn and a role definition name.
+
+```sh
+m365 spo file roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "Shared Documents/Test1.docx" --upn "testuser@tenant.onmicrosoft.com" --roleDefinitionName "Full Control"
+```
+
+Adds a role assignment to a file with a specified server-relative URL the for a specific group  and a role definition name.
+
+```sh
+m365 spo file roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "/sites/project-x/documents/Test1.docx" --upn "testuser@tenant.onmicrosoft.com" --roleDefinitionName "Read"
+```

package/docs/docs/cmd/spo/file/file-roleassignment-remove.md

@@ -0,0 +1,54 @@
+# spo file roleassignment remove
+
+Removes a role assignment from a file.
+
+## Usage
+
+```sh
+m365 spo file roleassignment remove [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the file is located.
+
+`--fileUrl [fileUrl]`
+: The server-relative URL of the file. Specify either `fileUrl` or `fileId` but not both.
+
+`-i, --fileId [fileId]`
+: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
+
+`--principalId [principalId]`
+: The SharePoint Id of the principal. It may be either a user id or group id. Specify either `upn`, `groupName`, or `principalId`.
+
+`--upn [upn]`
+: Upn/email of the user. Specify either `upn`, `groupName`, or `principalId`.
+
+`--groupName [groupName]`
+: The group name of an Azure AD or SharePoint group. Specify either `upn`, `groupName`, or `principalId`.
+
+`--confirm [confirm]`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Remove a role assignment by principal id from a file by id
+
+```sh
+m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --principalId 2
+```
+
+Remove a role assignment by upn from a file by url
+
+```sh
+m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileUrl "/sites/contoso-sales/documents/Test1.docx" --upn "user1@contoso.onmicrosoft.com"
+```
+
+Remove a role assignment by group name from a file by id
+
+```sh
+m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --groupName "saleGroup"
+```

package/docs/docs/cmd/spo/folder/folder-roleinheritance-break.md

@@ -0,0 +1,39 @@
+# spo folder roleinheritance break
+
+Breaks the role inheritance of a folder.
+
+## Usage
+
+```sh
+m365 spo folder roleinheritance break [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the folder is located.
+
+`-f, --folderUrl <folderUrl>`
+: The site-relative URL or server-relative URL of the folder.
+
+`-c, --clearExistingPermissions`
+: Clear all existing permissions from the folder.
+
+`--confirm`
+: Don't prompt for confirmation to breaking role inheritance of the folder.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Break the inheritance of a folder with a specified site-relative URL.
+
+```sh
+m365 spo folder roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "Shared Documents/TestFolder"
+```
+
+Break the inheritance of a folder with a specified server-relative URL. It will clear the existing permissions of the folder. It will **not** prompt for confirmation before breaking the inheritance.
+
+```sh
+m365 spo folder roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents/TestFolder" --clearExistingPermissions --confirm
+```

package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.md

@@ -0,0 +1,36 @@
+# spo folder roleinheritance reset
+
+Restores the role inheritance of a folder.
+
+## Usage
+
+```sh
+m365 spo folder roleinheritance reset [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the folder is located.
+
+`-f, --folderUrl <folderUrl>`
+: The site-relative URL of the folder.
+
+`--confirm`
+: Don't prompt for confirmation to reset role inheritance of the folder.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Reset inheritance of folder with site-relative url _Shared Documents/TestFolder_ located in site _https://contoso.sharepoint.com/sites/project-x_.
+
+```sh
+m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "Shared Documents/TestFolder"
+```
+
+Reset inheritance of folder with server-relative url _/sites/project-x/Shared Documents/TestFolder_ located in site _https://contoso.sharepoint.com/sites/project-x_. It will **not** prompt for confirmation before resetting.
+
+```sh
+m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents/TestFolder" --confirm
+```

package/docs/docs/cmd/spo/hubsite/hubsite-disconnect.md

@@ -1,6 +1,6 @@
 # spo hubsite disconnect
 
-Disconnects the specifies site collection from its hub site
+Disconnects the specified site collection from its hub site
 
 ## Usage
 

package/docs/docs/cmd/spo/hubsite/hubsite-get.md

@@ -11,13 +11,13 @@ m365 spo hubsite get [options]
 ## Options
 
 `-i, --id [id]`
-: ID of the hubsite. Specify either `id`, `title` or `url` but not multiple.
+: ID of the hub site. Specify either `id`, `title` or `url` but not multiple.
 
 `-t, --title [title]`
-: Title of the hubsite. Specify either `id`, `title` or `url` but not multiple.
+: Title of the hub site. Specify either `id`, `title` or `url` but not multiple.
 
 `-u, --url [url]`
-: URL of the hubsite. Specify either `id`, `title` or `url` but not multiple.
+: URL of the hub site. Specify either `id`, `title` or `url` but not multiple.
 
 `--includeAssociatedSites`
 : Include the associated sites in the result (only in JSON output)