@microsoft/sp-listview-extensibility 1.23.2 → 1.24.0-beta.3

package/dist/d37b65ee-c7d8-4570-bc74-2b294ff3b380.manifest.json

@@ -2,7 +2,7 @@
   "id": "d37b65ee-c7d8-4570-bc74-2b294ff3b380",
   "alias": "SPListViewExtensibility",
   "componentType": "Library",
-  "version": "1.23.2",
+  "version": "1.24.0",
   "manifestVersion": 2,
   "loaderConfig": {
     "internalModuleBaseUrls": [
@@ -13,29 +13,24 @@
       "sp-listview-extensibility": {
         "type": "path",
         "path": {
-          "path": "sp-listview-extensibility_none_94ba6a6b18c530c5bdda.js",
-          "integrity": "sha256-PZ9K02MZeehv3TzKtgRj8+0b8srywgAMM1ve9Yeu+qI="
+          "path": "sp-listview-extensibility_none_92a24595575d0757a2c6.js",
+          "integrity": "sha256-95myOUyRY/MCAUC7kfELnbGUwk46fgcfR2QGFRA5U9w="
         }
       },
-      "tslib": {
-        "type": "component",
-        "id": "01c4df03-e775-48cb-aa14-171ee5199a15",
-        "version": "2.3.1"
-      },
       "@microsoft/sp-core-library": {
         "type": "component",
         "id": "7263c7d0-1d6a-45ec-8d85-d4d1d234171b",
-        "version": "1.23.2"
+        "version": "1.24.0"
       },
       "@microsoft/sp-extension-base": {
         "type": "component",
         "id": "0773bd53-a69e-4293-87e6-ba80ea4d614b",
-        "version": "1.23.2"
+        "version": "1.24.0"
       },
       "@microsoft/sp-page-context": {
         "type": "component",
         "id": "1c4541f7-5c31-41aa-9fa8-fbc9dc14c0a8",
-        "version": "1.23.2"
+        "version": "1.24.0"
       }
     }
   }

package/dist/sp-listview-extensibility_none_92a24595575d0757a2c6.js

@@ -0,0 +1 @@
+define("d37b65ee-c7d8-4570-bc74-2b294ff3b380_1.24.0",["@microsoft/sp-core-library","@microsoft/sp-extension-base","@microsoft/sp-page-context"],(a,b,c)=>(()=>{"use strict";var d={676(b){b.exports=a},0(a){a.exports=b},408(a){a.exports=c}},e={};function f(a){var b=e[a];if(void 0!==b)return b.exports;var c=e[a]={exports:{}};return d[a](c,c.exports,f),c.exports}f.d=(a,b)=>{for(var c in b)f.o(b,c)&&!f.o(a,c)&&Object.defineProperty(a,c,{enumerable:!0,get:b[c]})},f.o=(a,b)=>Object.prototype.hasOwnProperty.call(a,b),f.r=a=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(a,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(a,"__esModule",{value:!0})};var g={};return(()=>{f.r(g),f.d(g,{BaseFieldCustomizer:()=>o,BaseFormCustomizer:()=>s,BaseListViewCommandSet:()=>j,ColumnAccessor:()=>w,Command:()=>k,FieldCustomizerContext:()=>p,FormCustomizerContext:()=>t,ListItemAccessor:()=>v,ListViewAccessor:()=>B,ListViewAccessorStateChanges:()=>d,ListViewCommandSetContext:()=>m,ListViewStateChangedEventArgs:()=>z,RowAccessor:()=>x,SelectedRowsChangedEventArgs:()=>y,_FormAction:()=>c,_FormActionEventArgs:()=>q,_FormCustomizerHost:()=>u});var a,b,c,d,e=f(676),h=f(0);class i extends h.BaseExtension{tryGetCommand(a){return e.Validate.isNonemptyString(a,"id"),this.context._commands.filter(b=>b.id===a)[0]}onListViewUpdated(a){}onExecute(a){}raiseOnChange(){this._raiseOnChange&&this._raiseOnChange()}constructor(...a){super(...a),this._raiseOnChange=void 0}}(0,e._ES5CompatibleClass)(i);let j=i;class k{}var l=f(408);class m extends h.ExtensionContext{get listView(){return this._listView}get _commands(){return this._commandArray}constructor(a,b){super(a),this._listView=b.listView,this._commandArray=[];const c=this.manifest.items;for(const a of Object.keys(c))if(e._SPFlight.isEnabled(62894)?"command"===c[a].type||"group"===c[a].type:"command"===c[a].type){let b=c[a].iconImageUrl;b&&!e.UrlUtilities.isDataUrl(b)&&(b=e.UrlUtilities.resolve(b,this.manifest.loaderConfig.internalModuleBaseUrls[0])),this._commandArray.push({id:a,title:c[a].title.default||"",ariaLabel:c[a].ariaLabel?c[a].ariaLabel.default:void 0,iconImageUrl:b,visible:!0,disabled:void 0})}this._commandArray.length&&this.serviceScope.whenFinished(()=>{let a=this.serviceScope.consume(l.PageContext.serviceKey).cultureInfo.currentUICultureName;this._commandArray.forEach(b=>{let d=c[b.id];b.title=e.Text._getLocalizedString(d.title,a)||"",d.ariaLabel&&(b.ariaLabel=e.Text._getLocalizedString(d.ariaLabel,a))})})}}class n extends h.BaseExtension{onRenderCell(a){let b=`${a.fieldValue}`;a.fieldValue.innerText=b}onDisposeCell(a){}}(0,e._ES5CompatibleClass)(n);let o=n;class p extends h.ExtensionContext{tryGetListView(){return this._listView}get field(){return this._field}constructor(a,b){super(a),this._listView=b.listView,this._field=b.field}}(a=c||(c={}))[a.Save=0]="Save",a[a.Close=1]="Close";class q extends e.SPEventArgs{constructor(a){super(),this.action=a}}class r extends h.BaseExtension{get domElement(){return this.context.domElement}get displayMode(){return this._displayMode}get formActionEvent(){return this._formActionEvent}_init(a,b,c){return c&&(this._displayMode=c.displayMode),super._init(a,b,c)}_internalRender(){this.render()}_internalSetDisplayMode(a){this._displayMode=a}_save(){e._SPEventManager.instance.raiseStickyEvent(r._formActionEventName,new q(c.Save))}_close(){e._SPEventManager.instance.raiseStickyEvent(r._formActionEventName,new q(c.Close))}dispose(){e._SPEventManager.instance.removeEvent(r._formActionEventName),super.dispose()}_initializeExtensionType(){super._initializeExtensionType(),this.context._host.logEngagement("init")}formSaved(){this.context._host.onSave()}formClosed(){this.context._host.onClose()}constructor(...a){super(...a),this._formActionEvent=new e.SPEvent(r._formActionEventName)}}r._formActionEventName="formCustomizer.formAction",(0,e._ES5CompatibleClass)(r);let s=r;class t extends h.ExtensionContext{get list(){return this._list}get contentType(){return this._contentType}get folderInfo(){return this._folderInfo}get itemId(){return this._itemId}get item(){return this._item}get domElement(){return this._domElement}get _host(){return this._formCustomizerHost}constructor(a,b){super(a),this._list=b.list,this._contentType=b.contentType,this._folderInfo=b.folderInfo,this._itemId=b.itemId,this._item=b.item,this._domElement=b.domElement,this._formCustomizerHost=b.host}}class u{onSave(){this.logEngagement("onSave"),this._onSaveCallback()}onClose(){this.logEngagement("onClose"),this._onCloseCallback()}onError(a){this.logEngagement("onError"),this._onErrorCallback&&this._onErrorCallback(a)}logEngagement(a){this._logEngagement&&this._logEngagement(a)}constructor(a){this._onSaveCallback=a.onSaveCallback,this._onCloseCallback=a.onCloseCallback,this._onErrorCallback=a.onErrorCallback,this._logEngagement=a.logEngagement}}class v{}class w{}class x extends v{constructor(){super()}}class y extends e.SPEventArgs{}class z extends e.SPEventArgs{}class A{get selectedRowsChangedEvent(){return this._selectedRowsChangedEvent}get listViewStateChangedEvent(){return this._listViewStateChangedEvent}dispose(){e._SPEventManager.instance.removeEvent(this._listViewStateChangedEventName),this._isDisposed=!0}get isDisposed(){return this._isDisposed}constructor(a){this._isDisposed=!1,this._selectedRowsChangedEvent=new e.SPEvent(A._selectedRowsChangedEventName),this._listViewStateChangedEventName=`${A._listViewStateChangedEventName}${a||""}`,this._listViewStateChangedEvent=new e.SPEvent(this._listViewStateChangedEventName)}}A._selectedRowsChangedEventName="listView.selectedRowsChanged",A._listViewStateChangedEventName="listView.stateChanged";let B=A;(b=d||(d={}))[b.None=0]="None",b[b.List=1]="List",b[b.View=2]="View",b[b.Columns=4]="Columns",b[b.SelectedRows=8]="SelectedRows",b[b.Rows=16]="Rows",b[b.AppliedFilters=32]="AppliedFilters",b[b.Sort=64]="Sort",b[b.FolderInfo=128]="FolderInfo"})(),g})());

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.57.7"
+      "packageVersion": "7.58.12"
     }
   ]
 }

package/lib-commonjs/commandSet/BaseListViewCommandSet.js

@@ -1,8 +1,15 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
-var sp_core_library_1 = require("@microsoft/sp-core-library");
-var sp_extension_base_1 = require("@microsoft/sp-extension-base");
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return _default;
+    }
+});
+const _spcorelibrary = require("@microsoft/sp-core-library");
+const _spextensionbase = require("@microsoft/sp-extension-base");
 /**
  * This is the base class that third parties should extend when implementing
  * a client-side extension that provides a command set for a SharePoint list view.
@@ -16,56 +23,49 @@ var sp_extension_base_1 = require("@microsoft/sp-extension-base");
  * so the hierarchy goes `BaseListViewCommandSet <- BaseCommandSet <- BaseExtension <- BaseComponent`.
  *
  * @public
- */
-var BaseListViewCommandSet = /** @class */ (function (_super) {
-    tslib_1.__extends(BaseListViewCommandSet, _super);
-    function BaseListViewCommandSet() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        /**
-         * @internal
-         */
-        _this._raiseOnChange = undefined; // provided by Command set adapter
-        return _this;
-    }
+ */ class BaseListViewCommandSet extends _spextensionbase.BaseExtension {
     /**
-     * Returns the command with the given id.
-     * Returns undefined if there is not command with the given id.
-     * @param id - Id of the command
-     */
-    BaseListViewCommandSet.prototype.tryGetCommand = function (id) {
-        sp_core_library_1.Validate.isNonemptyString(id, 'id');
-        var commands = this.context._commands.filter(function (command) { return command.id === id; });
+   * Returns the command with the given id.
+   * Returns undefined if there is not command with the given id.
+   * @param id - Id of the command
+   */ tryGetCommand(id) {
+        _spcorelibrary.Validate.isNonemptyString(id, 'id');
+        const commands = this.context._commands.filter((command)=>command.id === id);
         return commands[0];
-    };
+    }
     /**
-     * This event occurs whenever the ListView state changes.
-     * virtual
-     * @remarks
-     * This event allows the implementor to tailor the visibility of the command.
-     *
-     * @deprecated Use context.listView.listViewStateChangedEvent instead.
-     */
-    BaseListViewCommandSet.prototype.onListViewUpdated = function (event) {
-        // (implemented by child class)
-    };
+   * This event occurs whenever the ListView state changes.
+   * virtual
+   * @remarks
+   * This event allows the implementor to tailor the visibility of the command.
+   *
+   * @deprecated Use context.listView.listViewStateChangedEvent instead.
+   */ onListViewUpdated(event) {
+    // (implemented by child class)
+    }
     /**
-     * This event occurs when the command is invoked, e.g. because the user
-     * clicked on the toolbar button or menu item.
-     * virtual
-     */
-    BaseListViewCommandSet.prototype.onExecute = function (event) {
-        // (implemented by child class)
-    };
+   * This event occurs when the command is invoked, e.g. because the user
+   * clicked on the toolbar button or menu item.
+   * virtual
+   */ onExecute(event) {
+    // (implemented by child class)
+    }
     /**
-     * Use this method to fire OnChange event and initialize a reflow of the ListView.
-     */
-    BaseListViewCommandSet.prototype.raiseOnChange = function () {
+   * Use this method to fire OnChange event and initialize a reflow of the ListView.
+   */ raiseOnChange() {
         if (this._raiseOnChange) {
             this._raiseOnChange();
         }
-    };
-    return BaseListViewCommandSet;
-}(sp_extension_base_1.BaseExtension));
-(0, sp_core_library_1._ES5CompatibleClass)(BaseListViewCommandSet);
-exports.default = BaseListViewCommandSet;
-//# sourceMappingURL=BaseListViewCommandSet.js.map
+    }
+    constructor(...args){
+        super(...args);
+        /**
+   * @internal
+   */ this._raiseOnChange = undefined // provided by Command set adapter
+        ;
+    }
+}
+(0, _spcorelibrary._ES5CompatibleClass)(BaseListViewCommandSet);
+const _default = BaseListViewCommandSet;
+
+//# sourceMappingURL=./BaseListViewCommandSet.js.map

package/lib-commonjs/commandSet/Command.js

@@ -1,5 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * Represents a command belonging to a command set.
  *
@@ -10,11 +8,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * The command's appearance can be customized by assigning its properties, for example to hide a command that is not
  * contextually relevant, or to pluralize the title based on the number of selected items.
  * @public
- */
-var Command = /** @class */ (function () {
-    function Command() {
+ */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return Command;
     }
-    return Command;
-}());
-exports.default = Command;
-//# sourceMappingURL=Command.js.map
+});
+class Command {
+}
+
+//# sourceMappingURL=./Command.js.map

package/lib-commonjs/commandSet/ListViewCommandSetContext.js

@@ -1,40 +1,52 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
-var sp_extension_base_1 = require("@microsoft/sp-extension-base");
-var sp_core_library_1 = require("@microsoft/sp-core-library");
-var sp_page_context_1 = require("@microsoft/sp-page-context");
-var Flights_1 = require("../common/Flights");
-/**
- * This object provides contextual information for BaseListViewCommandSet.
- * @public
- */
-var ListViewCommandSetContext = /** @class */ (function (_super) {
-    tslib_1.__extends(ListViewCommandSetContext, _super);
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return ListViewCommandSetContext;
+    }
+});
+const _spextensionbase = require("@microsoft/sp-extension-base");
+const _spcorelibrary = require("@microsoft/sp-core-library");
+const _sppagecontext = require("@microsoft/sp-page-context");
+const _Flights = require("../common/Flights");
+class ListViewCommandSetContext extends _spextensionbase.ExtensionContext {
+    /**
+   * Provides access to the ListView control that the customizer will operate on.
+   */ get listView() {
+        return this._listView;
+    }
+    /**
+   * Returns an array with all commands.
+   *
+   * @privateRemarks
+   * In the future commands won't be a flat list. This allows us to get all commands together, so we can
+   * provide a straight-forward API tryGetCommand in the BaseListViewCommandSet itself.
+   *
+   * @internal
+   */ get _commands() {
+        return this._commandArray;
+    }
     /**
-     * @internal
-     */
-    function ListViewCommandSetContext(extensionContextParameters, listViewCommandSetContextParameters) {
-        var _this = _super.call(this, extensionContextParameters) || this;
-        _this._listView = listViewCommandSetContextParameters.listView;
-        _this._commandArray = [];
-        var itemsMap = _this.manifest.items;
-        for (var _i = 0, _a = Object.keys(itemsMap); _i < _a.length; _i++) {
-            var itemId = _a[_i];
-            var isValidCommand = (0, Flights_1.isSPFxListviewCommandSetGroupingEnabled)()
-                ? itemsMap[itemId].type === 'command' || itemsMap[itemId].type === 'group'
-                : itemsMap[itemId].type === 'command';
+   * @internal
+   */ constructor(extensionContextParameters, listViewCommandSetContextParameters){
+        super(extensionContextParameters);
+        this._listView = listViewCommandSetContextParameters.listView;
+        this._commandArray = [];
+        const itemsMap = this.manifest.items;
+        for (const itemId of Object.keys(itemsMap)){
+            const isValidCommand = (0, _Flights.isSPFxListviewCommandSetGroupingEnabled)() ? itemsMap[itemId].type === 'command' || itemsMap[itemId].type === 'group' : itemsMap[itemId].type === 'command';
             if (isValidCommand) {
-                var iconUrl = itemsMap[itemId].iconImageUrl;
-                if (iconUrl && !sp_core_library_1.UrlUtilities.isDataUrl(iconUrl)) {
-                    iconUrl = sp_core_library_1.UrlUtilities.resolve(iconUrl, _this.manifest.loaderConfig.internalModuleBaseUrls[0]);
+                let iconUrl = itemsMap[itemId].iconImageUrl;
+                if (iconUrl && !_spcorelibrary.UrlUtilities.isDataUrl(iconUrl)) {
+                    iconUrl = _spcorelibrary.UrlUtilities.resolve(iconUrl, this.manifest.loaderConfig.internalModuleBaseUrls[0]);
                 }
-                _this._commandArray.push({
+                this._commandArray.push({
                     id: itemId,
                     title: itemsMap[itemId].title.default || '',
-                    ariaLabel: itemsMap[itemId].ariaLabel
-                        ? itemsMap[itemId].ariaLabel.default
-                        : undefined,
+                    ariaLabel: itemsMap[itemId].ariaLabel ? itemsMap[itemId].ariaLabel.default : undefined,
                     iconImageUrl: iconUrl,
                     visible: true,
                     disabled: undefined
@@ -42,48 +54,20 @@ var ListViewCommandSetContext = /** @class */ (function (_super) {
             }
         }
         // updating title and ariaLabel based on UI culture
-        if (_this._commandArray.length) {
-            _this.serviceScope.whenFinished(function () {
-                var pageContext = _this.serviceScope.consume(sp_page_context_1.PageContext.serviceKey);
-                var currentUICulture = pageContext.cultureInfo.currentUICultureName;
-                _this._commandArray.forEach(function (command) {
-                    var item = itemsMap[command.id];
-                    command.title = sp_core_library_1.Text._getLocalizedString(item.title, currentUICulture) || '';
+        if (this._commandArray.length) {
+            this.serviceScope.whenFinished(()=>{
+                const pageContext = this.serviceScope.consume(_sppagecontext.PageContext.serviceKey);
+                const currentUICulture = pageContext.cultureInfo.currentUICultureName;
+                this._commandArray.forEach((command)=>{
+                    const item = itemsMap[command.id];
+                    command.title = _spcorelibrary.Text._getLocalizedString(item.title, currentUICulture) || '';
                     if (item.ariaLabel) {
-                        command.ariaLabel = sp_core_library_1.Text._getLocalizedString(item.ariaLabel, currentUICulture);
+                        command.ariaLabel = _spcorelibrary.Text._getLocalizedString(item.ariaLabel, currentUICulture);
                     }
                 });
             });
         }
-        return _this;
     }
-    Object.defineProperty(ListViewCommandSetContext.prototype, "listView", {
-        /**
-         * Provides access to the ListView control that the customizer will operate on.
-         */
-        get: function () {
-            return this._listView;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(ListViewCommandSetContext.prototype, "_commands", {
-        /**
-         * Returns an array with all commands.
-         *
-         * @privateRemarks
-         * In the future commands won't be a flat list. This allows us to get all commands together, so we can
-         * provide a straight-forward API tryGetCommand in the BaseListViewCommandSet itself.
-         *
-         * @internal
-         */
-        get: function () {
-            return this._commandArray;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    return ListViewCommandSetContext;
-}(sp_extension_base_1.ExtensionContext));
-exports.default = ListViewCommandSetContext;
-//# sourceMappingURL=ListViewCommandSetContext.js.map
+}
+
+//# sourceMappingURL=./ListViewCommandSetContext.js.map

package/lib-commonjs/common/Flights.js

@@ -1,11 +1,17 @@
-"use strict";
 // @copyright Microsoft Corporation. All rights reserved.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSPFxListviewCommandSetGroupingEnabled = void 0;
-var sp_core_library_1 = require("@microsoft/sp-core-library");
-// https://spoflights.azurewebsites.net/Flight/Edit/SPFxListviewCommandSetGroupingEnabled
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "isSPFxListviewCommandSetGroupingEnabled", {
+    enumerable: true,
+    get: function() {
+        return isSPFxListviewCommandSetGroupingEnabled;
+    }
+});
+const _spcorelibrary = require("@microsoft/sp-core-library");
 function isSPFxListviewCommandSetGroupingEnabled() {
-    return sp_core_library_1._SPFlight.isEnabled(62894 /* SPFxListviewCommandSetGroupingEnabled */);
+    return _spcorelibrary._SPFlight.isEnabled(62894 /* SPFxListviewCommandSetGroupingEnabled */ );
 }
-exports.isSPFxListviewCommandSetGroupingEnabled = isSPFxListviewCommandSetGroupingEnabled;
-//# sourceMappingURL=Flights.js.map
+
+//# sourceMappingURL=./Flights.js.map

package/lib-commonjs/common/IListItem.js

@@ -1,3 +1,6 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=IListItem.js.map
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+
+//# sourceMappingURL=./IListItem.js.map

package/lib-commonjs/common/ListItemAccessor.js

@@ -1,27 +1,17 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * When a field customizer extension is rendering a field, the ListItemAccessor provides
- * access to the associated SharePoint list item.
- *
- * @remarks
- *
- * ListItemAccessor allows a field customizer extension to determine which fields are available
- * in the editor and retrieve the current values for those fields.  In the future, it may
- * also support validation and editing operations.
- *
- * When the editor is the SharePoint list view, the ListViewAccessor uses the RowAccessor
- * subclass instead of the ListItemAccessor base class.  This allows additional functionality
- * to be exposed, for example determining whether the associated table row is selected or not.
- *
- * @public
- */
-var ListItemAccessor = /** @class */ (function () {
-    /** @internal */
-    function ListItemAccessor() {
-        // (mark constructor as internal)
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return ListItemAccessor;
     }
-    return ListItemAccessor;
-}());
-exports.default = ListItemAccessor;
-//# sourceMappingURL=ListItemAccessor.js.map
+});
+class ListItemAccessor {
+    /** @internal */ constructor(){
+    // (mark constructor as internal)
+    }
+}
+
+//# sourceMappingURL=./ListItemAccessor.js.map