@pnp/cli-microsoft365 11.4.0-beta.37c2235 → 11.4.0-beta.810a987

package/dist/m365/spp/commands/autofillcolumn/autofillcolumn-set.js

@@ -0,0 +1,166 @@
+import request from '../../../../request.js';
+import { formatting } from '../../../../utils/formatting.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 { globalOptionsZod } from '../../../../Command.js';
+import z from 'zod';
+var AllowedFieldTypeKind;
+(function (AllowedFieldTypeKind) {
+    AllowedFieldTypeKind[AllowedFieldTypeKind["Integer"] = 1] = "Integer";
+    AllowedFieldTypeKind[AllowedFieldTypeKind["Text"] = 2] = "Text";
+    AllowedFieldTypeKind[AllowedFieldTypeKind["Note"] = 3] = "Note";
+    AllowedFieldTypeKind[AllowedFieldTypeKind["DateTime"] = 4] = "DateTime";
+    AllowedFieldTypeKind[AllowedFieldTypeKind["Counter"] = 5] = "Counter";
+    AllowedFieldTypeKind[AllowedFieldTypeKind["Choice"] = 6] = "Choice";
+    AllowedFieldTypeKind[AllowedFieldTypeKind["Boolean"] = 8] = "Boolean";
+    AllowedFieldTypeKind[AllowedFieldTypeKind["Number"] = 9] = "Number";
+    AllowedFieldTypeKind[AllowedFieldTypeKind["Currency"] = 10] = "Currency";
+    AllowedFieldTypeKind[AllowedFieldTypeKind["URL"] = 11] = "URL";
+    AllowedFieldTypeKind[AllowedFieldTypeKind["Computed"] = 12] = "Computed";
+    AllowedFieldTypeKind[AllowedFieldTypeKind["MultiChoice"] = 15] = "MultiChoice";
+    AllowedFieldTypeKind[AllowedFieldTypeKind["GridChoice"] = 16] = "GridChoice";
+})(AllowedFieldTypeKind || (AllowedFieldTypeKind = {}));
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    siteUrl: z.string().refine(url => validation.isValidSharePointUrl(url) === true, {
+        error: e => `'${e.input}' is not a valid SharePoint Online site URL.`
+    }).alias('u'),
+    listTitle: z.string().optional(),
+    listId: z.string().uuid()
+        .refine(value => validation.isValidGuid(value), {
+        error: e => `'${e.input}' in parameter listId is not a valid GUID.`
+    }).optional(),
+    listUrl: z.string().optional(),
+    columnId: z.string().uuid()
+        .refine(value => validation.isValidGuid(value), {
+        error: e => `'${e.input}' in parameter columnId is not a valid GUID.`
+    }).optional().alias('i'),
+    columnTitle: z.string().optional().alias('t'),
+    columnInternalName: z.string().optional(),
+    prompt: z.string().optional(),
+    isEnabled: z.boolean().optional()
+}).strict();
+class SppAutofillColumnSetCommand extends SpoCommand {
+    get name() {
+        return commands.AUTOFILLCOLUMN_SET;
+    }
+    get description() {
+        return 'Applies the autofill option to the selected column';
+    }
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => [options.columnId, options.columnTitle, options.columnInternalName].filter(Boolean).length === 1, {
+            message: `Specify exactly one of the following options: 'columnId', 'columnTitle' or 'columnInternalName'.`
+        })
+            .refine(options => [options.listTitle, options.listId, options.listUrl].filter(Boolean).length === 1, {
+            message: `Specify exactly one of the following options: 'listTitle', 'listId' or 'listUrl'.`
+        });
+    }
+    async commandAction(logger, args) {
+        try {
+            if (this.verbose) {
+                await logger.log(`Applying an autofill column to a column...`);
+            }
+            const siteUrl = urlUtil.removeTrailingSlashes(args.options.siteUrl);
+            const listInstance = await this.getDocumentLibraryInfo(siteUrl, args.options);
+            if (listInstance.BaseType !== 1) {
+                throw Error(`The specified list is not a document library.`);
+            }
+            const column = await this.getColumn(siteUrl, args.options, listInstance.Id);
+            if (!Object.values(AllowedFieldTypeKind).includes(column.FieldTypeKind)) {
+                throw Error(`The specified column has incorrect type.`);
+            }
+            if (column.AutofillInfo) {
+                await this.updateAutoFillColumnSettings(siteUrl, args.options, column.Id, listInstance.Id, column.AutofillInfo);
+                return;
+            }
+            if (!args.options.prompt) {
+                throw Error(`The prompt parameter is required when setting the autofill column for the first time.`);
+            }
+            await this.applyAutoFillColumnSettings(siteUrl, args.options, column.Id, column.Title, listInstance.Id);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+    getDocumentLibraryInfo(siteUrl, options) {
+        let requestUrl = `${siteUrl}/_api/web`;
+        if (options.listId) {
+            requestUrl += `/lists(guid'${formatting.encodeQueryParameter(options.listId)}')`;
+        }
+        else if (options.listTitle) {
+            requestUrl += `/lists/getByTitle('${formatting.encodeQueryParameter(options.listTitle)}')`;
+        }
+        else if (options.listUrl) {
+            const listServerRelativeUrl = urlUtil.getServerRelativePath(siteUrl, options.listUrl);
+            requestUrl += `/GetList('${formatting.encodeQueryParameter(listServerRelativeUrl)}')`;
+        }
+        const requestOptions = {
+            url: `${requestUrl}?$select=Id,BaseType`,
+            headers: {
+                'accept': 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        return request.get(requestOptions);
+    }
+    getColumn(siteUrl, options, listId) {
+        let fieldRestUrl = '';
+        if (options.columnId) {
+            fieldRestUrl = `/getbyid('${formatting.encodeQueryParameter(options.columnId)}')`;
+        }
+        else {
+            fieldRestUrl = `/getbyinternalnameortitle('${formatting.encodeQueryParameter((options.columnTitle || options.columnInternalName))}')`;
+        }
+        const requestOptions = {
+            url: `${siteUrl}/_api/web/lists(guid'${formatting.encodeQueryParameter(listId)}')/fields${fieldRestUrl}?&$select=Id,Title,FieldTypeKind,AutofillInfo`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        return request.get(requestOptions);
+    }
+    updateAutoFillColumnSettings(siteUrl, options, columnId, listInstanceId, autofillInfo) {
+        const autofillInfoObj = JSON.parse(autofillInfo);
+        const requestOptions = {
+            url: `${siteUrl}/_api/machinelearning/SetColumnLLMInfo`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json',
+            data: {
+                autofillPrompt: options.prompt ?? autofillInfoObj.LLM.Prompt,
+                columnId: columnId,
+                docLibId: `{${listInstanceId}}`,
+                isEnabled: options.isEnabled !== undefined ? options.isEnabled : autofillInfoObj.LLM.IsEnabled
+            }
+        };
+        return request.post(requestOptions);
+    }
+    applyAutoFillColumnSettings(siteUrl, options, columnId, columnTitle, listInstanceId) {
+        const requestOptions = {
+            url: `${siteUrl}/_api/machinelearning/SetSyntexPoweredColumnPrompts`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            data: {
+                docLibId: `{${listInstanceId}}`,
+                syntexPoweredColumnPrompts: JSON.stringify([{
+                        columnId: columnId,
+                        columnName: columnTitle,
+                        prompt: options.prompt,
+                        isEnabled: options.isEnabled !== undefined ? options.isEnabled : true
+                    }])
+            }
+        };
+        return request.post(requestOptions);
+    }
+}
+export default new SppAutofillColumnSetCommand();
+//# sourceMappingURL=autofillcolumn-set.js.map

package/dist/m365/spp/commands.js

@@ -1,5 +1,6 @@
 const prefix = 'spp';
 export default {
+    AUTOFILLCOLUMN_SET: `${prefix} autofillcolumn set`,
     CONTENTCENTER_LIST: `${prefix} contentcenter list`,
     MODEL_APPLY: `${prefix} model apply`,
     MODEL_GET: `${prefix} model get`,

package/docs/docs/cmd/spp/autofillcolumn/autofillcolumn-set.mdx

@@ -0,0 +1,104 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spp autofillcolumn set
+
+Applies the autofill option to the selected column
+
+## Usage
+
+```sh
+m365 spp autofillcolumn set [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --siteUrl <siteUrl>`
+: The URL of the target site.
+
+`--listTitle [listTitle]`
+: The title of the library on which to apply the model. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
+
+`--listId [listId]`
+: The ID of the library on which to apply the model. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
+
+`--listUrl [listUrl]`
+: Server or web-relative URL of the library on which to apply the model. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
+
+`-i, --columnId [columnId]`
+: ID of the column to which the autofill option will be assigned. Specify either `columnId`, `columnTitle` or `columnInternalName`.
+
+`-t, --columnTitle [columnTitle]`
+: Title of the column to which the autofill option will be assigned. Specify either `columnId`, `columnTitle` or `columnInternalName`.
+
+`--columnInternalName [columnInternalName]`
+: The internal name (case-sensitive) of the column to which the autofill option will be assigned. Specify either `columnId`, `columnTitle` or `columnInternalName`.
+
+`--prompt [prompt]`
+: The text in natural language that will be used to extract specific information or generate information from files within a SharePoint library.
+
+`--isEnabled [isEnabled]`
+: Enables or disables the autofill column feature.
+```
+
+<Global />
+
+## Remarks
+
+The `prompt` parameter is required when setting the autofill column for the first time.
+
+## Examples
+
+Applies an autofill column on a selected column to a document library based on the list id.
+
+```sh
+m365 spp autofillcolumn set --siteUrl "https://contoso.sharepoint.com/sites/mainSite" --listId "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc" --columnId "1045e69d-21fb-4214-a25a-9bdfa7cb63a2" --prompt "Write a 2-line summary of the document"
+```
+
+Applies an autofill column on a selected column to a document library based on the list title.
+
+```sh
+m365 spp autofillcolumn set --siteUrl "https://contoso.sharepoint.com/sites/mainSite" --listTitle "Documents" --columnId "1045e69d-21fb-4214-a25a-9bdfa7cb63a2" --prompt "Write a 2-line summary of the document"
+```
+
+Applies an autofill column on a selected column to a document library based on the list url.
+
+```sh
+m365 spp autofillcolumn set --siteUrl "https://contoso.sharepoint.com/sites/mainSite" --listUrl '/Shared Documents' --columnId "1045e69d-21fb-4214-a25a-9bdfa7cb63a2" --prompt "Write a 2-line summary of the document"
+```
+
+Applies an autofill column on a selected column to a document library based on the list id and column title.
+
+```sh
+m365 spp autofillcolumn set --siteUrl "https://contoso.sharepoint.com/sites/mainSite" --listId "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc" --columnTitle "ColumnTitle" --prompt "Write a 2-line summary of the document"
+```
+
+Applies an autofill column on a selected column to a document library based on the list id and column internal name.
+
+```sh
+m365 spp autofillcolumn set --siteUrl "https://contoso.sharepoint.com/sites/mainSite" --listId "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc" --columnInternalName "ColumnTitle" --prompt "Write a 2-line summary of the document"
+```
+
+Disables the autofill column for a selected column in a document library, based on the list id and column title.
+
+```sh
+m365 spp autofillcolumn set --siteUrl "https://contoso.sharepoint.com/sites/mainSite" --listId "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc" --columnTitle "ColumnTitle" --isEnabled false
+```
+
+Reenable the autofill column for a selected column in a document library, based on the list id and column title.
+
+```sh
+m365 spp autofillcolumn set --siteUrl "https://contoso.sharepoint.com/sites/mainSite" --listId "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc" --columnTitle "ColumnTitle" --isEnabled true
+```
+
+Modifies the prompt for the autofill column
+
+```sh
+m365 spp autofillcolumn set --siteUrl "https://contoso.sharepoint.com/sites/mainSite" --listId "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc" --columnTitle "ColumnTitle" --isEnabled true --prompt "Write a 1-line summary of the document"
+```
+
+## Response
+
+The command won't return a response on success.

package/eslint.config.mjs

@@ -23,6 +23,7 @@ const dictionary = [
   'assets',
   'assignment',
   'audit',
+  'autofill',
   'azure',
   'bin',
   'builder',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "11.4.0-beta.37c2235",
+  "version": "11.4.0-beta.810a987",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",