@pnp/cli-microsoft365 7.5.0 → 7.6.0-beta.c74fe4b

package/dist/cli/cli.js

@@ -98,7 +98,7 @@ async function execute(rawArgs) {
         if (parsedArgs.output !== 'none') {
             printHelp(await getHelpMode(parsedArgs));
         }
-        return Promise.resolve();
+        return;
     }
     delete cli.optionsFromArgs.options._;
     delete cli.optionsFromArgs.options['--'];

package/dist/m365/purview/commands/threatassessment/threatassessment-add.js

@@ -0,0 +1,123 @@
+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 _PurviewThreatAssessmentAddCommand_instances, _PurviewThreatAssessmentAddCommand_initTelemetry, _PurviewThreatAssessmentAddCommand_initOptions, _PurviewThreatAssessmentAddCommand_initValidators, _PurviewThreatAssessmentAddCommand_initOptionSets;
+import request from '../../../../request.js';
+import { accessToken } from '../../../../utils/accessToken.js';
+import GraphCommand from '../../../base/GraphCommand.js';
+import commands from '../../commands.js';
+import auth from '../../../../Auth.js';
+import fs from 'fs';
+import path from 'path';
+class PurviewThreatAssessmentAddCommand extends GraphCommand {
+    get name() {
+        return commands.THREATASSESSMENT_ADD;
+    }
+    get description() {
+        return 'Create a threat assessment';
+    }
+    constructor() {
+        super();
+        _PurviewThreatAssessmentAddCommand_instances.add(this);
+        this.allowedTypes = ['file', 'url'];
+        this.allowedExpectedAssessments = ['block', 'unblock'];
+        this.allowedCategories = ['spam', 'phishing', 'malware'];
+        __classPrivateFieldGet(this, _PurviewThreatAssessmentAddCommand_instances, "m", _PurviewThreatAssessmentAddCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _PurviewThreatAssessmentAddCommand_instances, "m", _PurviewThreatAssessmentAddCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _PurviewThreatAssessmentAddCommand_instances, "m", _PurviewThreatAssessmentAddCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _PurviewThreatAssessmentAddCommand_instances, "m", _PurviewThreatAssessmentAddCommand_initOptionSets).call(this);
+    }
+    async commandAction(logger, args) {
+        try {
+            if (accessToken.isAppOnlyAccessToken(auth.connection.accessTokens[this.resource].accessToken)) {
+                throw 'This command currently does not support app only permissions.';
+            }
+            if (this.verbose) {
+                await logger.logToStderr(`Adding threat assessment of type ${args.options.type} with expected assessment ${args.options.expectedAssessment} and category ${args.options.category}`);
+            }
+            const requestBody = {
+                expectedAssessment: args.options.expectedAssessment,
+                category: args.options.category,
+                url: args.options.url,
+                contentData: args.options.path && fs.readFileSync(args.options.path).toString('base64'),
+                fileName: args.options.path && path.basename(args.options.path)
+            };
+            switch (args.options.type) {
+                case 'file':
+                    requestBody['@odata.type'] = '#microsoft.graph.fileAssessmentRequest';
+                    break;
+                case 'url':
+                    requestBody['@odata.type'] = '#microsoft.graph.urlAssessmentRequest';
+                    break;
+            }
+            const requestOptions = {
+                url: `${this.resource}/v1.0/informationProtection/threatAssessmentRequests`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                data: requestBody,
+                responseType: 'json'
+            };
+            const response = await request.post(requestOptions);
+            await logger.log(response);
+        }
+        catch (err) {
+            this.handleRejectedODataPromise(err);
+        }
+    }
+}
+_PurviewThreatAssessmentAddCommand_instances = new WeakSet(), _PurviewThreatAssessmentAddCommand_initTelemetry = function _PurviewThreatAssessmentAddCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            path: typeof args.options.path !== 'undefined',
+            url: typeof args.options.url !== 'undefined'
+        });
+    });
+}, _PurviewThreatAssessmentAddCommand_initOptions = function _PurviewThreatAssessmentAddCommand_initOptions() {
+    this.options.unshift({
+        option: '-t, --type <type>',
+        autocomplete: this.allowedTypes
+    }, {
+        option: '-e, --expectedAssessment <expectedAssessment>',
+        autocomplete: this.allowedExpectedAssessments
+    }, {
+        option: '-c, --category <category>',
+        autocomplete: this.allowedCategories
+    }, {
+        option: '-p, --path [path]'
+    }, {
+        option: '-u, --url [url]'
+    });
+}, _PurviewThreatAssessmentAddCommand_initValidators = function _PurviewThreatAssessmentAddCommand_initValidators() {
+    this.validators.push(async (args) => {
+        if (!this.allowedTypes.some(type => type === args.options.type)) {
+            return `${args.options.type} is not an allowed type. Allowed types are ${this.allowedTypes.join('|')}`;
+        }
+        if (!this.allowedExpectedAssessments.some(expectedAssessment => expectedAssessment === args.options.expectedAssessment)) {
+            return `${args.options.expectedAssessment} is not an allowed expected assessment. Allowed expected assessments are ${this.allowedExpectedAssessments.join('|')}`;
+        }
+        if (!this.allowedCategories.some(category => category === args.options.category)) {
+            return `${args.options.category} is not an allowed category. Allowed categories are ${this.allowedCategories.join('|')}`;
+        }
+        if (args.options.path && !fs.existsSync(args.options.path)) {
+            return `File '${args.options.path}' not found. Please provide a valid path to the file.`;
+        }
+        return true;
+    });
+}, _PurviewThreatAssessmentAddCommand_initOptionSets = function _PurviewThreatAssessmentAddCommand_initOptionSets() {
+    this.optionSets.push({
+        options: ['path'],
+        runsWhen: (args) => {
+            return args.options.type === 'file';
+        }
+    }, {
+        options: ['url'],
+        runsWhen: (args) => {
+            return args.options.type === 'url';
+        }
+    });
+};
+export default new PurviewThreatAssessmentAddCommand();
+//# sourceMappingURL=threatassessment-add.js.map

package/dist/m365/purview/commands/threatassessment/threatassessment-list.js

@@ -0,0 +1,104 @@
+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 _PurviewThreatAssessmentListCommand_instances, _a, _PurviewThreatAssessmentListCommand_initTelemetry, _PurviewThreatAssessmentListCommand_initOptions, _PurviewThreatAssessmentListCommand_initValidators;
+import { odata } from '../../../../utils/odata.js';
+import GraphCommand from '../../../base/GraphCommand.js';
+import commands from '../../commands.js';
+class PurviewThreatAssessmentListCommand extends GraphCommand {
+    get name() {
+        return commands.THREATASSESSMENT_LIST;
+    }
+    get description() {
+        return 'Get a list of threat assessments';
+    }
+    defaultProperties() {
+        return ['id', 'type', 'category'];
+    }
+    constructor() {
+        super();
+        _PurviewThreatAssessmentListCommand_instances.add(this);
+        __classPrivateFieldGet(this, _PurviewThreatAssessmentListCommand_instances, "m", _PurviewThreatAssessmentListCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _PurviewThreatAssessmentListCommand_instances, "m", _PurviewThreatAssessmentListCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _PurviewThreatAssessmentListCommand_instances, "m", _PurviewThreatAssessmentListCommand_initValidators).call(this);
+    }
+    async commandAction(logger, args) {
+        if (this.verbose) {
+            logger.logToStderr('Retrieving a list of threat assessments');
+        }
+        try {
+            const filter = this.getFilterQuery(args.options);
+            const items = await odata.getAllItems(`${this.resource}/v1.0/informationProtection/threatAssessmentRequests${filter}`, 'minimal');
+            let itemsToReturn = [];
+            switch (args.options.type) {
+                case 'mail':
+                    itemsToReturn = items.filter(item => item['@odata.type'] === '#microsoft.graph.mailAssessmentRequest');
+                    break;
+                case 'emailFile':
+                    itemsToReturn = items.filter(item => item['@odata.type'] === '#microsoft.graph.emailFileAssessmentRequest');
+                    break;
+                default:
+                    itemsToReturn = items;
+                    break;
+            }
+            for (const item of itemsToReturn) {
+                item['type'] = this.getConvertedType(item['@odata.type']);
+                delete item['@odata.type'];
+            }
+            await logger.log(itemsToReturn);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+    // Content type is not equal to type. 
+    // Threat assessments of type emailFile have contentType mail as well.
+    // This function gets the correct filter URL to be able to query the least amount of data
+    getFilterQuery(options) {
+        if (options.type === undefined) {
+            return '';
+        }
+        if (options.type === 'emailFile') {
+            return `?$filter=contentType eq 'mail'`;
+        }
+        return `?$filter=contentType eq '${options.type}'`;
+    }
+    getConvertedType(type) {
+        switch (type) {
+            case '#microsoft.graph.mailAssessmentRequest':
+                return 'mail';
+            case '#microsoft.graph.fileAssessmentRequest':
+                return 'file';
+            case '#microsoft.graph.emailFileAssessmentRequest':
+                return 'emailFile';
+            case '#microsoft.graph.urlAssessmentRequest':
+                return 'url';
+            default:
+                return 'Unknown';
+        }
+    }
+}
+_a = PurviewThreatAssessmentListCommand, _PurviewThreatAssessmentListCommand_instances = new WeakSet(), _PurviewThreatAssessmentListCommand_initTelemetry = function _PurviewThreatAssessmentListCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            type: typeof args.options.type !== 'undefined'
+        });
+    });
+}, _PurviewThreatAssessmentListCommand_initOptions = function _PurviewThreatAssessmentListCommand_initOptions() {
+    this.options.unshift({
+        option: '-t, --type [type]',
+        autocomplete: _a.allowedTypes
+    });
+}, _PurviewThreatAssessmentListCommand_initValidators = function _PurviewThreatAssessmentListCommand_initValidators() {
+    this.validators.push(async (args) => {
+        if (args.options.type && _a.allowedTypes.indexOf(args.options.type) < 0) {
+            return `${args.options.type} is not a valid type. Allowed values are ${_a.allowedTypes.join(', ')}`;
+        }
+        return true;
+    });
+};
+PurviewThreatAssessmentListCommand.allowedTypes = ['mail', 'file', 'emailFile', 'url'];
+export default new PurviewThreatAssessmentListCommand();
+//# sourceMappingURL=threatassessment-list.js.map

package/dist/m365/purview/commands.js

@@ -18,6 +18,8 @@ export default {
     SENSITIVITYLABEL_GET: `${prefix} sensitivitylabel get`,
     SENSITIVITYLABEL_LIST: `${prefix} sensitivitylabel list`,
     SENSITIVITYLABEL_POLICYSETTINGS_LIST: `${prefix} sensitivitylabel policysettings list`,
-    THREATASSESSMENT_GET: `${prefix} threatassessment get`
+    THREATASSESSMENT_ADD: `${prefix} threatassessment add`,
+    THREATASSESSMENT_GET: `${prefix} threatassessment get`,
+    THREATASSESSMENT_LIST: `${prefix} threatassessment list`
 };
 //# sourceMappingURL=commands.js.map

package/docs/docs/cmd/purview/threatassessment/threatassessment-add.mdx

@@ -0,0 +1,131 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# purview threatassessment add
+
+Create a threat assessment
+
+## Usage
+
+```sh
+m365 purview threatassessment add [options]
+```
+
+## Options
+
+```md definition-list
+`-t, --type <type>`
+: The type of threat assessment to retrieve. Supports `file` and `url`.
+
+`-e, --expectedAssessment <expectedAssessment>`
+: The expected assessment from submitter. Possible values are: `block` and `unblock`.
+
+`-c, --category <category>`
+: The threat category. Possible values are: `spam`, `phishing`, `malware`.
+
+`-p, --path [path]`
+: Local path to the file to upload. Can only be used for threat assessment with type `file`.
+
+`-u, --url [url]`
+: The URL string. Can only be used for threat assessment with type `url`.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+    This command currently only supports delegated permissions.
+
+:::
+
+## Examples
+
+Create a file threat assessment
+
+```sh
+m365 purview threatassessment add --type file --expectedAssessment block --category malware --fileName 'test.txt' --path 'C:\Path\To\File.txt'
+```
+
+Create a url threat assessment
+
+```sh
+m365 purview threatassessment add --type url --expectedAssessment block --category phishing --url 'http://contoso.com'
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+    {
+      "id": "b0e69f1c-adda-4df2-2906-08dc2caa6b3f",
+      "createdDateTime": "2024-02-13T15:42:43.5131654Z",
+      "contentType": "file",
+      "expectedAssessment": "block",
+      "category": "malware",
+      "status": "pending",
+      "requestSource": "administrator",
+      "fileName": "test.txt",
+      "contentData": "dGVzdC50eHQ=",
+      "createdBy": {
+        "user": {
+          "id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a",
+          "displayName": "John Doe"
+        }
+      }
+    }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  category          : malware
+  contentData       : dGVzdC50eHQ=
+  contentType       : file
+  createdBy         : {"user":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"John Doe"}}
+  createdDateTime   : 2024-02-13T16:15:00.4125206Z
+  expectedAssessment: block
+  fileName          : test.txt
+  id                : be1223c4-4e92-4a4c-8c16-08dc2caeedba
+  requestSource     : administrator
+  status            : pending
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,createdDateTime,contentType,expectedAssessment,category,status,requestSource,fileName,contentData
+  d31eb5f5-ecd5-4a8e-fb2a-08dc2caf00a8,2024-02-13T16:15:32.1741098Z,file,block,malware,pending,administrator,test.txt,dGVzdC50eHQ=
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # purview threatassessment add --type "file" --expectedAssessment "block" --category "malware" --path "C:\temp\test.txt"
+
+  Date: 13/02/2024
+
+  ## e3524baf-6ea6-4fab-68af-08dc2caf0ae3
+
+  Property | Value
+  ---------|-------
+  id | e3524baf-6ea6-4fab-68af-08dc2caf0ae3
+  createdDateTime | 2024-02-13T16:15:49.3342383Z
+  contentType | file
+  expectedAssessment | block
+  category | malware
+  status | pending
+  requestSource | administrator
+  fileName | test.txt
+  contentData | dGVzdC50eHQ=
+  ```
+
+  </TabItem>
+</Tabs>

package/docs/docs/cmd/purview/threatassessment/threatassessment-list.mdx

@@ -0,0 +1,110 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# purview threatassessment list
+
+Get a list of threat assessments
+
+## Usage
+
+```sh
+m365 purview threatassessment list [options]
+```
+
+## Options
+
+```md definition-list
+`-t, --type [type]`
+: The type of threat assessment to retrieve. Allowed values are `mail`, `file`, `emailFile` and `url`.
+```
+
+<Global />
+
+## Examples
+
+Get a list of threat assessments
+
+```sh
+m365 purview threatassessment list
+```
+
+Get a list of threat assessments of type _mail_
+
+```sh
+m365 purview threatassessment list --type mail
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "type": "mail",
+      "id": "49c5ef5b-1f65-444a-e6b9-08d772ea2059",
+      "createdDateTime": "2019-11-27T03:30:18.6890937Z",
+      "contentType": "mail",
+      "expectedAssessment": "block",
+      "category": "spam",
+      "status": "pending",
+      "requestSource": "administrator",
+      "recipientEmail": "john@contoso.onmicrosoft.com",
+      "destinationRoutingReason": "notJunk",
+      "messageUri": "https://graph.microsoft.com/v1.0/users/c52ce8db-3e4b-4181-93c4-7d6b6bffaf60/messages/AAMkADU3MWUxOTU0LWNlOTEt=",
+      "createdBy": {
+        "user": {
+          "id": "c52ce8db-3e4b-4181-93c4-7d6b6bffaf60",
+          "displayName": "John Doe"
+        }
+      }
+    }
+  ];
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  id                                    type  category
+  ------------------------------------  -----------  --------
+  49c5ef5b-1f65-444a-e6b9-08d772ea2059  mail         spam
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,type,category
+  49c5ef5b-1f65-444a-e6b9-08d772ea2059,mail,spam
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # purview threatassessment list
+
+  Date: 16/2/2023
+
+  ## a47e428c-a7bd-4cf2-f061-08db0f58b736
+
+  Property | Value
+  ---------|-------
+  type | mail
+  id | 49c5ef5b-1f65-444a-e6b9-08d772ea2059
+  createdDateTime | 2019-11-27T03:30:18.6890937Z
+  contentType | mail
+  expectedAssessment | block
+  category | spam
+  status | pending
+  recipientEmail | john@contoso.onmicrosoft.com
+  destinationRoutingReason | notJunk
+  messageUri | https://graph.microsoft.com/v1.0/users/c52ce8db-3e4b-4181-93c4-7d6b6bffaf60/messages/AAMkADU3MWUxOTU0LWNlOTEt=
+  createdBy | {"user":{"id":"c52ce8db-3e4b-4181-93c4-7d6b6bffaf60","displayName":"John Doe"}}
+  ```
+
+  </TabItem>
+</Tabs>

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "7.5.0",
+  "version": "7.6.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@pnp/cli-microsoft365",
-      "version": "7.5.0",
+      "version": "7.6.0",
       "license": "MIT",
       "dependencies": {
         "@azure/msal-common": "^14.7.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "7.5.0",
+  "version": "7.6.0-beta.c74fe4b",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",
@@ -302,4 +302,4 @@
     "sinon": "^17.0.0",
     "source-map-support": "^0.5.21"
   }
-}
+}