@pnp/cli-microsoft365 10.8.0-beta.7160233 → 10.8.0-beta.a1c69a6

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

@@ -43,6 +43,9 @@ class SpoListGetCommand extends SpoCommand {
             const listServerRelativeUrl = urlUtil.getServerRelativePath(args.options.webUrl, args.options.url);
             requestUrl += `GetList('${formatting.encodeQueryParameter(listServerRelativeUrl)}')`;
         }
+        else if (args.options.default) {
+            requestUrl += `DefaultDocumentLibrary`;
+        }
         const fieldsProperties = this.formatSelectProperties(args.options.properties, args.options.withPermissions);
         const queryParams = [];
         if (fieldsProperties.selectProperties.length > 0) {
@@ -113,11 +116,12 @@ class SpoListGetCommand extends SpoCommand {
 _SpoListGetCommand_instances = new WeakSet(), _SpoListGetCommand_initTelemetry = function _SpoListGetCommand_initTelemetry() {
     this.telemetry.push((args) => {
         Object.assign(this.telemetryProperties, {
-            id: (!(!args.options.id)).toString(),
-            title: (!(!args.options.title)).toString(),
-            url: (!(!args.options.url)).toString(),
-            properties: (!(!args.options.properties)).toString(),
-            withPermissions: typeof args.options.withPermissions !== 'undefined'
+            id: typeof args.options.id !== 'undefined',
+            title: typeof args.options.title !== 'undefined',
+            url: typeof args.options.url !== 'undefined',
+            properties: typeof args.options.properties !== 'undefined',
+            withPermissions: !!args.options.withPermissions,
+            default: !!args.options.default
         });
     });
 }, _SpoListGetCommand_initOptions = function _SpoListGetCommand_initOptions() {
@@ -129,6 +133,8 @@ _SpoListGetCommand_instances = new WeakSet(), _SpoListGetCommand_initTelemetry =
         option: '-t, --title [title]'
     }, {
         option: '--url [url]'
+    }, {
+        option: '--default'
     }, {
         option: '-p, --properties [properties]'
     }, {
@@ -148,7 +154,7 @@ _SpoListGetCommand_instances = new WeakSet(), _SpoListGetCommand_initTelemetry =
         return true;
     });
 }, _SpoListGetCommand_initOptionSets = function _SpoListGetCommand_initOptionSets() {
-    this.optionSets.push({ options: ['id', 'title', 'url'] });
+    this.optionSets.push({ options: ['id', 'title', 'url', 'default'] });
 };
 export default new SpoListGetCommand();
 //# sourceMappingURL=list-get.js.map

package/dist/m365/spp/commands/model/model-apply.js

@@ -0,0 +1,130 @@
+import request from '../../../../request.js';
+import { formatting } from '../../../../utils/formatting.js';
+import { spp } from '../../../../utils/spp.js';
+import { urlUtil } from '../../../../utils/urlUtil.js';
+import { validation } from '../../../../utils/validation.js';
+import SpoCommand from '../../../base/SpoCommand.js';
+import commands from '../../commands.js';
+import { z } from 'zod';
+import { globalOptionsZod } from '../../../../Command.js';
+import { zod } from '../../../../utils/zod.js';
+const options = globalOptionsZod
+    .extend({
+    contentCenterUrl: zod.alias('c', z.string()
+        .refine(url => validation.isValidSharePointUrl(url) === true, url => ({
+        message: `'${url}' is not a valid SharePoint Online site URL.`
+    }))),
+    webUrl: zod.alias('u', z.string()
+        .refine(url => validation.isValidSharePointUrl(url) === true, url => ({
+        message: `'${url}' is not a valid SharePoint Online site URL.`
+    }))),
+    id: zod.alias('i', z.string()
+        .refine(id => validation.isValidGuid(id) === true, id => ({
+        message: `${id} is not a valid GUID.`
+    })).optional()),
+    title: zod.alias('t', z.string()).optional(),
+    listTitle: z.string().optional(),
+    listId: z.string()
+        .refine(listId => validation.isValidGuid(listId) === true, listId => ({
+        message: `${listId} is not a valid GUID.`
+    })).optional(),
+    listUrl: z.string().optional(),
+    viewOption: z.enum(['NewViewAsDefault', 'DoNotChangeDefault', 'TileViewAsDefault']).optional()
+})
+    .strict();
+class SppModelApplyCommand extends SpoCommand {
+    get name() {
+        return commands.MODEL_APPLY;
+    }
+    get description() {
+        return 'Applies (or syncs) a trained document understanding model to a document library';
+    }
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => [options.id, options.title].filter(x => x !== undefined).length === 1, {
+            message: `Specify exactly one of the following options: 'id' or 'title'.`
+        })
+            .refine(options => [options.listTitle, options.listId, options.listUrl].filter(x => x !== undefined).length === 1, {
+            message: `Specify exactly one of the following options: 'listTitle', 'listId' or 'listUrl'.`
+        });
+    }
+    async commandAction(logger, args) {
+        try {
+            const contentCenterUrl = urlUtil.removeTrailingSlashes(args.options.contentCenterUrl);
+            await spp.assertSiteIsContentCenter(contentCenterUrl, logger, this.verbose);
+            let model = null;
+            if (args.options.title) {
+                model = await spp.getModelByTitle(contentCenterUrl, args.options.title, logger, this.verbose);
+            }
+            else {
+                model = await spp.getModelById(contentCenterUrl, args.options.id, logger, this.verbose);
+            }
+            if (this.verbose) {
+                await logger.log(`Retrieving list information...`);
+            }
+            const listInstance = await this.getListInfo(args.options.webUrl, args.options.listId, args.options.listTitle, args.options.listUrl);
+            if (listInstance.BaseType !== 1) {
+                throw `The specified list is not a document library.`;
+            }
+            if (this.verbose) {
+                await logger.log(`Applying model '${model.ModelName}' to document library '${listInstance.RootFolder.ServerRelativeUrl}'...`);
+            }
+            const requestOptions = {
+                url: `${contentCenterUrl}/_api/machinelearning/publications`,
+                headers: {
+                    accept: 'application/json;odata=nometadata',
+                    'Content-Type': 'application/json;odata=verbose'
+                },
+                responseType: 'json',
+                data: {
+                    __metadata: { type: 'Microsoft.Office.Server.ContentCenter.SPMachineLearningPublicationsEntityData' },
+                    Publications: {
+                        results: [
+                            {
+                                ModelUniqueId: model.UniqueId,
+                                TargetSiteUrl: args.options.webUrl,
+                                TargetWebServerRelativeUrl: urlUtil.getServerRelativeSiteUrl(args.options.webUrl),
+                                TargetLibraryServerRelativeUrl: listInstance.RootFolder.ServerRelativeUrl,
+                                ViewOption: args.options.viewOption ?? "NewViewAsDefault"
+                            }
+                        ]
+                    }
+                }
+            };
+            const result = await request.post(requestOptions);
+            const resultDetails = result.Details;
+            if (resultDetails && resultDetails[0]?.ErrorMessage) {
+                throw resultDetails[0].ErrorMessage;
+            }
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+    getListInfo(webUrl, listId, listTitle, listUrl) {
+        let requestUrl = `${webUrl}/_api/web`;
+        if (listId) {
+            requestUrl += `/lists(guid'${formatting.encodeQueryParameter(listId)}')`;
+        }
+        else if (listTitle) {
+            requestUrl += `/lists/getByTitle('${formatting.encodeQueryParameter(listTitle)}')`;
+        }
+        else if (listUrl) {
+            const listServerRelativeUrl = urlUtil.getServerRelativePath(webUrl, listUrl);
+            requestUrl += `/GetList('${formatting.encodeQueryParameter(listServerRelativeUrl)}')`;
+        }
+        const requestOptions = {
+            url: `${requestUrl}?$select=BaseType,RootFolder/ServerRelativeUrl&$expand=RootFolder`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        return request.get(requestOptions);
+    }
+}
+export default new SppModelApplyCommand();
+//# sourceMappingURL=model-apply.js.map

package/dist/m365/spp/commands/model/model-get.js

@@ -4,8 +4,6 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _SppModelGetCommand_instances, _SppModelGetCommand_initTelemetry, _SppModelGetCommand_initOptions, _SppModelGetCommand_initValidators, _SppModelGetCommand_initOptionSets, _SppModelGetCommand_initTypes;
-import request from '../../../../request.js';
-import { formatting } from '../../../../utils/formatting.js';
 import { odata } from '../../../../utils/odata.js';
 import { spp } from '../../../../utils/spp.js';
 import { urlUtil } from '../../../../utils/urlUtil.js';
@@ -30,34 +28,19 @@ class SppModelGetCommand extends SpoCommand {
     }
     async commandAction(logger, args) {
         try {
-            if (this.verbose) {
-                await logger.log(`Retrieving model information from ${args.options.siteUrl}...`);
-            }
             const siteUrl = urlUtil.removeTrailingSlashes(args.options.siteUrl);
-            await spp.assertSiteIsContentCenter(siteUrl);
-            let requestUrl = `${siteUrl}/_api/machinelearning/models/`;
+            await spp.assertSiteIsContentCenter(siteUrl, logger, this.verbose);
+            let result = null;
             if (args.options.title) {
-                let requestTitle = args.options.title.toLowerCase();
-                if (!requestTitle.endsWith('.classifier')) {
-                    requestTitle += '.classifier';
-                }
-                requestUrl += `getbytitle('${formatting.encodeQueryParameter(requestTitle)}')`;
+                result = await spp.getModelByTitle(siteUrl, args.options.title, logger, this.verbose);
             }
             else {
-                requestUrl += `getbyuniqueid('${args.options.id}')`;
-            }
-            const requestOptions = {
-                url: requestUrl,
-                headers: {
-                    accept: 'application/json;odata=nometadata'
-                },
-                responseType: 'json'
-            };
-            const result = await request.get(requestOptions);
-            if (result['odata.null'] === true) {
-                throw 'Model not found.';
+                result = await spp.getModelById(siteUrl, args.options.id, logger, this.verbose);
             }
             if (args.options.withPublications) {
+                if (this.verbose) {
+                    await logger.log(`Retrieving publications for model...`);
+                }
                 result.Publications = await odata.getAllItems(`${siteUrl}/_api/machinelearning/publications/getbymodeluniqueid('${result.UniqueId}')`);
             }
             await logger.log({

package/dist/m365/spp/commands/model/model-list.js

@@ -33,7 +33,7 @@ class SppModelListCommand extends SpoCommand {
                 await logger.log(`Retrieving models from ${args.options.siteUrl}...`);
             }
             const siteUrl = urlUtil.removeTrailingSlashes(args.options.siteUrl);
-            await spp.assertSiteIsContentCenter(siteUrl);
+            await spp.assertSiteIsContentCenter(siteUrl, logger, this.verbose);
             const result = await odata.getAllItems(`${siteUrl}/_api/machinelearning/models`);
             await logger.log(result);
         }

package/dist/m365/spp/commands/model/model-remove.js

@@ -40,7 +40,7 @@ class SppModelRemoveCommand extends SpoCommand {
                 await logger.log(`Removing model from ${args.options.siteUrl}...`);
             }
             const siteUrl = urlUtil.removeTrailingSlashes(args.options.siteUrl);
-            await spp.assertSiteIsContentCenter(siteUrl);
+            await spp.assertSiteIsContentCenter(siteUrl, logger, this.verbose);
             let requestUrl = `${siteUrl}/_api/machinelearning/models/`;
             if (args.options.title) {
                 let requestTitle = args.options.title.toLowerCase();

package/dist/m365/spp/commands.js

@@ -1,6 +1,7 @@
 const prefix = 'spp';
 export default {
     CONTENTCENTER_LIST: `${prefix} contentcenter list`,
+    MODEL_APPLY: `${prefix} model apply`,
     MODEL_GET: `${prefix} model get`,
     MODEL_LIST: `${prefix} model list`,
     MODEL_REMOVE: `${prefix} model remove`

package/dist/utils/spp.js

@@ -1,11 +1,17 @@
 import request from '../request.js';
+import { formatting } from './formatting.js';
 export const spp = {
     /**
      * Asserts whether the specified site is a content center
      * @param siteUrl The URL of the site to check
+     * @param logger Logger instance
+     * @param verbose Whether to log verbose messages
      * @throws error when site is not a content center.
      */
-    async assertSiteIsContentCenter(siteUrl) {
+    async assertSiteIsContentCenter(siteUrl, logger, verbose) {
+        if (verbose) {
+            await logger.log(`Checking if '${siteUrl}' is a valid content center site...`);
+        }
         const requestOptions = {
             url: `${siteUrl}/_api/web?$select=WebTemplateConfiguration`,
             headers: {
@@ -17,6 +23,58 @@ export const spp = {
         if (response.WebTemplateConfiguration !== 'CONTENTCTR#0') {
             throw Error(`${siteUrl} is not a content site.`);
         }
+    },
+    /**
+     * Gets a SharePoint Premium model by title
+     * @param contentCenterUrl a content center site URL
+     * @param title model title
+     * @param logger Logger instance
+     * @param verbose Whether to log verbose messages
+     * @returns SharePoint Premium model
+     */
+    async getModelByTitle(contentCenterUrl, title, logger, verbose) {
+        if (verbose) {
+            await logger.log(`Retrieving model information...`);
+        }
+        let requestTitle = title.toLowerCase();
+        if (!requestTitle.endsWith('.classifier')) {
+            requestTitle += '.classifier';
+        }
+        const requestUrl = `${contentCenterUrl}/_api/machinelearning/models/getbytitle('${formatting.encodeQueryParameter(requestTitle)}')`;
+        const requestOptions = {
+            url: requestUrl,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        const result = await request.get(requestOptions);
+        if (result['odata.null'] === true) {
+            throw Error(`Model '${title}' was not found.`);
+        }
+        return result;
+    },
+    /**
+     * Gets a SharePoint Premium model by unique id
+     * @param contentCenterUrl a content center site URL
+     * @param id model unique id
+     * @param logger Logger instance
+     * @param verbose Whether to log verbose messages
+     * @returns SharePoint Premium model
+     */
+    async getModelById(contentCenterUrl, id, logger, verbose) {
+        if (verbose) {
+            await logger.log(`Retrieving model information...`);
+        }
+        const requestUrl = `${contentCenterUrl}/_api/machinelearning/models/getbyuniqueid('${id}')`;
+        const requestOptions = {
+            url: requestUrl,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        return await request.get(requestOptions);
     }
 };
 //# sourceMappingURL=spp.js.map

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

@@ -19,13 +19,16 @@ m365 spo list get [options]
 : URL of the site where the list to retrieve is located.
 
 `-i, --id [id]`
-: ID of the list to retrieve information for. Specify either `id`, `title`, or `url` but not multiple.
+: ID of the list to retrieve information for. Specify either `id`, `title`,`url` or `default` but not multiple.
 
 `-t, --title [title]`
-: Title of the list to retrieve information for. Specify either `id`, `title`, or `url` but not multiple.
+: Title of the list to retrieve information for. Specify either `id`, `title`,`url` or `default` but not multiple.
 
 `--url [url]`
-: Server- or site-relative URL of the list. Specify either `id`, `title`, or `url` but not multiple.
+: Server- or site-relative URL of the list. Specify either `id`, `title`,`url` or `default` but not multiple.
+
+`--default`
+: Set to retrieve the default list from the site. Specify either `id`, `title`, `url`, or `default` but not multiple.  
 
 `-p, --properties [properties]`
 : Comma-separated list of properties to retrieve from the list. Will retrieve all properties possible from default response, if not specified.
@@ -42,6 +45,12 @@ When the `properties` option includes values with a `/`, for example: `ListItemA
 
 ## Examples
 
+Get the default document library located in the specified site.
+
+```sh
+m365 spo list get --webUrl https://contoso.sharepoint.com/sites/project-x --default  
+```
+
 Get information about a list with specified ID located in the specified site.
 
 ```sh

package/docs/docs/cmd/spp/model/model-apply.mdx

@@ -0,0 +1,79 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spp model apply
+
+Applies (or syncs) a trained document understanding model to a document library
+
+## Usage
+
+```sh
+m365 spp model apply [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the web where the library is located.
+
+`-c, --contentCenterUrl <contentCenterUrl>`
+: The URL of the content center site where model is located.
+
+`-i, --id [id]`
+: The unique ID of the model. Specify either `id` or `title` but not both.
+
+`-t, --title [title]`
+: The display name of the model. Specify either `id` or `title` but not both.
+
+`--listTitle [listTitle]`
+: The title of the document library to which the model will be applied. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
+
+`--listId [listId]`
+: The ID of the library to which the model will be applied. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
+
+`--listUrl [listUrl]`
+: Server or web-relative URL of the library to which the model will be applied. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
+
+`--viewOption [viewOption]`
+: Defines whether the model view should be set as the default view for the document library. Allowed values are: `NewViewAsDefault`, `DoNotChangeDefault`, `TileViewAsDefault`. The default value is `NewViewAsDefault`.
+```
+
+<Global />
+
+## Examples
+
+Applies a trained document understanding model using its unique ID to a document library, identified by its title.
+
+```sh
+m365 spp model apply --webUrl "https://contoso.sharepoint.com" --contentCenterUrl "https://contoso.sharepoint.com/sites/ContentCenter" --id "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc" --listTitle "Shared Documents"
+```
+
+Applies a trained document understanding model using its display name to a document library, identified by its title.
+
+```sh
+m365 spp model apply --webUrl "https://contoso.sharepoint.com" --contentCenterUrl "https://contoso.sharepoint.com/sites/ContentCenter" --title "ModelExample" --listTitle "Shared Documents"
+```
+
+Applies a trained document understanding model using its display name to a document library, identified by its URL.
+
+```sh
+m365 spp model apply --webUrl "https://contoso.sharepoint.com" --contentCenterUrl "https://contoso.sharepoint.com/sites/ContentCenter" --title "ModelExample" --listUrl "/Shared Documents"
+```
+
+Applies a trained document understanding model using its display name to a document library, identified by its unique ID.
+
+```sh
+m365 spp model apply --webUrl "https://contoso.sharepoint.com" --contentCenterUrl "https://contoso.sharepoint.com/sites/ContentCenter" --title "ModelExample" --listId "b4cfa0d9-b3d7-49ae-a0f0-f14ffdd005f7"
+```
+
+Applies a trained document understanding model using its display name to a document library, identified by its unique ID. Without changing a default document library view.
+
+```sh
+m365 spp model apply --webUrl "https://contoso.sharepoint.com" --contentCenterUrl "https://contoso.sharepoint.com/sites/ContentCenter" --title "ModelExample" --listId "b4cfa0d9-b3d7-49ae-a0f0-f14ffdd005f7" --viewOption "DoNotChangeDefault"
+```
+
+## Response
+
+The command won't return a response on success.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "10.8.0-beta.7160233",
+  "version": "10.8.0-beta.a1c69a6",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",
@@ -177,7 +177,7 @@
     "Levert, Sebastien <slevert@outlook.com>",
     "Lingstuyl, Martin <mlingstuyl@live.com>",
     "Macháček, Martin <machacek@edhouse.cz>",
-    "Maestrini Tobias <tobias@bee365.ch>",
+    "Maestrini, Tobias <tobias.maestrini@gmail.com>",
     "Maillot, Michaël <battosaimykle@gmail.com>",
     "Mastykarz, Waldek <waldek@mastykarz.nl>",
     "McDonnell, Kevin <kevin@mcd79.com>",