@microsoft/sp-listview-extensibility 1.23.1 → 1.24.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/dist/d37b65ee-c7d8-4570-bc74-2b294ff3b380.manifest.json +6 -11
  2. package/dist/sp-listview-extensibility_none_e2a79004ecc8bfd2e643.js +1 -0
  3. package/dist/tsdoc-metadata.json +1 -1
  4. package/lib-commonjs/commandSet/BaseListViewCommandSet.js +49 -49
  5. package/lib-commonjs/commandSet/Command.js +13 -9
  6. package/lib-commonjs/commandSet/ListViewCommandSetContext.js +54 -70
  7. package/lib-commonjs/common/Flights.js +14 -8
  8. package/lib-commonjs/common/IListItem.js +5 -2
  9. package/lib-commonjs/common/ListItemAccessor.js +15 -25
  10. package/lib-commonjs/common/ListViewAccessor.js +83 -135
  11. package/lib-commonjs/common/ListViewAccessorState.js +13 -10
  12. package/lib-commonjs/fieldCustomizer/BaseFieldCustomizer.js +25 -25
  13. package/lib-commonjs/fieldCustomizer/FieldCustomizerContext.js +36 -43
  14. package/lib-commonjs/formCustomizer/BaseFormCustomizer.js +93 -114
  15. package/lib-commonjs/formCustomizer/FormActionEventArgs.js +27 -26
  16. package/lib-commonjs/formCustomizer/FormCustomizerContext.js +61 -98
  17. package/lib-commonjs/formCustomizer/FormCustomizerHost.js +34 -33
  18. package/lib-commonjs/index.js +79 -37
  19. package/lib-esm/commandSet/BaseListViewCommandSet.js +61 -0
  20. package/{lib → lib-esm}/commandSet/Command.js +4 -8
  21. package/lib-esm/commandSet/ListViewCommandSetContext.js +67 -0
  22. package/{lib → lib-esm}/common/Flights.js +3 -2
  23. package/lib-esm/common/IListItem.js +7 -0
  24. package/{lib → lib-esm}/common/ListItemAccessor.js +8 -10
  25. package/lib-esm/common/ListViewAccessor.js +102 -0
  26. package/{lib → lib-esm}/common/ListViewAccessorState.js +3 -7
  27. package/lib-esm/fieldCustomizer/BaseFieldCustomizer.js +27 -0
  28. package/lib-esm/fieldCustomizer/FieldCustomizerContext.js +34 -0
  29. package/lib-esm/formCustomizer/BaseFormCustomizer.js +106 -0
  30. package/lib-esm/formCustomizer/FormActionEventArgs.js +18 -0
  31. package/lib-esm/formCustomizer/FormCustomizerContext.js +59 -0
  32. package/lib-esm/formCustomizer/FormCustomizerHost.js +47 -0
  33. package/{lib → lib-esm}/index.js +3 -3
  34. package/package.json +35 -8
  35. package/dist/sp-listview-extensibility_none_53622c3076b31a20ece6.js +0 -1
  36. package/lib/commandSet/BaseListViewCommandSet.d.ts.map +0 -1
  37. package/lib/commandSet/BaseListViewCommandSet.js +0 -69
  38. package/lib/commandSet/Command.d.ts.map +0 -1
  39. package/lib/commandSet/ListViewCommandSetContext.d.ts.map +0 -1
  40. package/lib/commandSet/ListViewCommandSetContext.js +0 -87
  41. package/lib/common/Flights.d.ts.map +0 -1
  42. package/lib/common/IListItem.d.ts.map +0 -1
  43. package/lib/common/IListItem.js +0 -2
  44. package/lib/common/ListItemAccessor.d.ts.map +0 -1
  45. package/lib/common/ListViewAccessor.d.ts.map +0 -1
  46. package/lib/common/ListViewAccessor.js +0 -146
  47. package/lib/common/ListViewAccessorState.d.ts.map +0 -1
  48. package/lib/fieldCustomizer/BaseFieldCustomizer.d.ts.map +0 -1
  49. package/lib/fieldCustomizer/BaseFieldCustomizer.js +0 -35
  50. package/lib/fieldCustomizer/FieldCustomizerContext.d.ts.map +0 -1
  51. package/lib/fieldCustomizer/FieldCustomizerContext.js +0 -45
  52. package/lib/formCustomizer/BaseFormCustomizer.d.ts.map +0 -1
  53. package/lib/formCustomizer/BaseFormCustomizer.js +0 -135
  54. package/lib/formCustomizer/FormActionEventArgs.d.ts.map +0 -1
  55. package/lib/formCustomizer/FormActionEventArgs.js +0 -28
  56. package/lib/formCustomizer/FormCustomizerContext.d.ts.map +0 -1
  57. package/lib/formCustomizer/FormCustomizerContext.js +0 -99
  58. package/lib/formCustomizer/FormCustomizerHost.d.ts.map +0 -1
  59. package/lib/formCustomizer/FormCustomizerHost.js +0 -49
  60. package/lib/index.d.ts.map +0 -1
  61. /package/{lib → lib-dts}/commandSet/BaseListViewCommandSet.d.ts +0 -0
  62. /package/{lib → lib-dts}/commandSet/Command.d.ts +0 -0
  63. /package/{lib → lib-dts}/commandSet/ListViewCommandSetContext.d.ts +0 -0
  64. /package/{lib → lib-dts}/common/Flights.d.ts +0 -0
  65. /package/{lib → lib-dts}/common/IListItem.d.ts +0 -0
  66. /package/{lib → lib-dts}/common/ListItemAccessor.d.ts +0 -0
  67. /package/{lib → lib-dts}/common/ListViewAccessor.d.ts +0 -0
  68. /package/{lib → lib-dts}/common/ListViewAccessorState.d.ts +0 -0
  69. /package/{lib → lib-dts}/fieldCustomizer/BaseFieldCustomizer.d.ts +0 -0
  70. /package/{lib → lib-dts}/fieldCustomizer/FieldCustomizerContext.d.ts +0 -0
  71. /package/{lib → lib-dts}/formCustomizer/BaseFormCustomizer.d.ts +0 -0
  72. /package/{lib → lib-dts}/formCustomizer/FormActionEventArgs.d.ts +0 -0
  73. /package/{lib → lib-dts}/formCustomizer/FormCustomizerContext.d.ts +0 -0
  74. /package/{lib → lib-dts}/formCustomizer/FormCustomizerHost.d.ts +0 -0
  75. /package/{lib → lib-dts}/index.d.ts +0 -0
  76. /package/{lib → lib-esm}/sp-listview-extensibility.manifest.json +0 -0
@@ -0,0 +1,102 @@
1
+ import { SPEvent, SPEventArgs, _SPEventManager } from '@microsoft/sp-core-library';
2
+ import ListItemAccessor from './ListItemAccessor';
3
+ /**
4
+ * Provides access to a ListView column, which is the visual presentation
5
+ * of a field.
6
+ *
7
+ * @remarks
8
+ *
9
+ * A SharePoint "field" (SPField) defines the data storage for a property of a list item.
10
+ * (If the list item represents a document, then the field is sometimes called a "property".)
11
+ *
12
+ * A "column" is the visual presentation of a field, when displayed by the ListView.
13
+ *
14
+ * @public
15
+ */ export class ColumnAccessor {
16
+ /** @internal */ constructor(){
17
+ // (mark constructor as internal)
18
+ }
19
+ }
20
+ /**
21
+ * Provides access to a ListView row, which is the visual presentation
22
+ * of a SharePoint list item.
23
+ *
24
+ * @remarks
25
+ *
26
+ * A SharePoint "list item" (SPListItem) is a data storage record in the content
27
+ * management system; it stores an array of values for the associated fields.
28
+ *
29
+ * A "row" is the visual presentation of a list item, when displayed by the ListView;
30
+ * it stores an array of cell values for the associated columns.
31
+ *
32
+ * @public
33
+ */ export class RowAccessor extends ListItemAccessor {
34
+ /**
35
+ * @internal
36
+ */ constructor(){
37
+ super();
38
+ }
39
+ }
40
+ /**
41
+ * Arguments for the selected rows changed event.
42
+ *
43
+ * @public
44
+ */ export class SelectedRowsChangedEventArgs extends SPEventArgs {
45
+ }
46
+ /**
47
+ * Arguments for the list view state changed event.
48
+ *
49
+ * @public
50
+ */ export class ListViewStateChangedEventArgs extends SPEventArgs {
51
+ }
52
+ /**
53
+ * Provides access to a SharePoint ListView control.
54
+ *
55
+ * @public
56
+ */ class ListViewAccessor {
57
+ /**
58
+ * Event that gets raised every time the selected items in the list view change.
59
+ * @eventproperty
60
+ */ get selectedRowsChangedEvent() {
61
+ return this._selectedRowsChangedEvent;
62
+ }
63
+ /**
64
+ * Event that gets raised every time the list view state changes.
65
+ *
66
+ * @eventproperty
67
+ */ get listViewStateChangedEvent() {
68
+ return this._listViewStateChangedEvent;
69
+ }
70
+ /**
71
+ * @internal
72
+ */ dispose() {
73
+ _SPEventManager.instance.removeEvent(this._listViewStateChangedEventName);
74
+ this._isDisposed = true;
75
+ }
76
+ /**
77
+ * @internal
78
+ */ get isDisposed() {
79
+ return this._isDisposed;
80
+ }
81
+ /**
82
+ * @internal
83
+ */ constructor(eventPrefix){
84
+ this._isDisposed = false;
85
+ this._selectedRowsChangedEvent = new SPEvent(ListViewAccessor._selectedRowsChangedEventName);
86
+ this._listViewStateChangedEventName = `${ListViewAccessor._listViewStateChangedEventName}${eventPrefix || ''}`;
87
+ this._listViewStateChangedEvent = new SPEvent(this._listViewStateChangedEventName);
88
+ }
89
+ }
90
+ /**
91
+ * SPEvent name when the selected rows in a list have changed.
92
+ *
93
+ * @internal
94
+ */ ListViewAccessor._selectedRowsChangedEventName = 'listView.selectedRowsChanged';
95
+ /**
96
+ * SPEvent name when the list view state has changed.
97
+ *
98
+ * @internal
99
+ */ ListViewAccessor._listViewStateChangedEventName = 'listView.stateChanged';
100
+ export default ListViewAccessor;
101
+
102
+ //# sourceMappingURL=./ListViewAccessor.js.map
@@ -1,10 +1,5 @@
1
- /**
2
- * Describes the type of list view state changes.
3
- *
4
- * @public
5
- */
6
1
  export var ListViewAccessorStateChanges;
7
- (function (ListViewAccessorStateChanges) {
2
+ (function(ListViewAccessorStateChanges) {
8
3
  ListViewAccessorStateChanges[ListViewAccessorStateChanges["None"] = 0] = "None";
9
4
  ListViewAccessorStateChanges[ListViewAccessorStateChanges["List"] = 1] = "List";
10
5
  ListViewAccessorStateChanges[ListViewAccessorStateChanges["View"] = 2] = "View";
@@ -15,4 +10,5 @@ export var ListViewAccessorStateChanges;
15
10
  ListViewAccessorStateChanges[ListViewAccessorStateChanges["Sort"] = 64] = "Sort";
16
11
  ListViewAccessorStateChanges[ListViewAccessorStateChanges["FolderInfo"] = 128] = "FolderInfo";
17
12
  })(ListViewAccessorStateChanges || (ListViewAccessorStateChanges = {}));
18
- //# sourceMappingURL=ListViewAccessorState.js.map
13
+
14
+ //# sourceMappingURL=./ListViewAccessorState.js.map
@@ -0,0 +1,27 @@
1
+ import { _ES5CompatibleClass } from '@microsoft/sp-core-library';
2
+ import { BaseExtension } from '@microsoft/sp-extension-base';
3
+ /**
4
+ * This is the base class that third parties should extend when implementing
5
+ * a client-side extension that customizes the appearance of fields in
6
+ * a SharePoint ListView.
7
+ *
8
+ * In the component manifest, the "extensionType" should be set to "FieldCustomizer".
9
+ *
10
+ * @public
11
+ */ class BaseFieldCustomizer extends BaseExtension {
12
+ /*
13
+ * virtual
14
+ */ onRenderCell(event) {
15
+ const text = `${event.fieldValue}`;
16
+ event.fieldValue.innerText = text;
17
+ }
18
+ /*
19
+ * virtual
20
+ */ onDisposeCell(event) {
21
+ // (implemented by child class)
22
+ }
23
+ }
24
+ _ES5CompatibleClass(BaseFieldCustomizer);
25
+ export default BaseFieldCustomizer;
26
+
27
+ //# sourceMappingURL=./BaseFieldCustomizer.js.map
@@ -0,0 +1,34 @@
1
+ import { ExtensionContext } from '@microsoft/sp-extension-base';
2
+ class FieldCustomizerContext extends ExtensionContext {
3
+ /**
4
+ * If the field customizer is bounded to the SharePoint list view, this provides access
5
+ * to the list view specific functionality; otherwise the value is undefined.
6
+ *
7
+ * @remarks
8
+ * Although the SharePoint list view is the main usage scenario, field customizers
9
+ * can be used by other user interface surfaces. For example, in the future SharePoint
10
+ * may support field customizers on a display/edit form.
11
+ *
12
+ * @returns the SharePoint list view, or undefined if there is none.
13
+ */ tryGetListView() {
14
+ return this._listView;
15
+ }
16
+ /**
17
+ * Provides access to the SharePoint field that the customizer will operate on.
18
+ */ get field() {
19
+ return this._field;
20
+ }
21
+ /**
22
+ * @internal
23
+ */ constructor(extensionContextParameters, fieldCustomizerContextParameters){
24
+ super(extensionContextParameters);
25
+ this._listView = fieldCustomizerContextParameters.listView;
26
+ this._field = fieldCustomizerContextParameters.field;
27
+ }
28
+ }
29
+ /**
30
+ * This object provides contextual information for BaseFieldCustomizer.
31
+ * @public
32
+ */ export { FieldCustomizerContext as default };
33
+
34
+ //# sourceMappingURL=./FieldCustomizerContext.js.map
@@ -0,0 +1,106 @@
1
+ import { BaseExtension } from '@microsoft/sp-extension-base';
2
+ import { SPEvent, _SPEventManager, _ES5CompatibleClass } from '@microsoft/sp-core-library';
3
+ import { FormAction, FormActionEventArgs } from './FormActionEventArgs';
4
+ /**
5
+ * This is the base class that third parties should extend when implementing
6
+ * a client-side extension that provides a custom list form (display, new, edit) for a SharePoint list.
7
+ * @public
8
+ */ class BaseFormCustomizer extends BaseExtension {
9
+ // Readonly protected properties. To change these to readonly once TypeScript supports that feature.
10
+ /**
11
+ * This property is a pointer to the root DOM element of the form. This is a DIV element and contains the whole
12
+ * DOM subtree of the form.
13
+ *
14
+ * @readonly
15
+ */ get domElement() {
16
+ return this.context.domElement;
17
+ }
18
+ /**
19
+ * Display mode of the form: Edit, Display or New.
20
+ *
21
+ * @readonly
22
+ */ get displayMode() {
23
+ return this._displayMode;
24
+ }
25
+ /**
26
+ * Event that gets raised every time the selected items in the list view change.
27
+ * Reserved for the future.
28
+ *
29
+ * @eventproperty
30
+ * @internal
31
+ */ get formActionEvent() {
32
+ return this._formActionEvent;
33
+ }
34
+ /**
35
+ * @internal
36
+ */ _init(context, propertiesJson, additionalInitParameters) {
37
+ if (additionalInitParameters) {
38
+ this._displayMode = additionalInitParameters.displayMode;
39
+ }
40
+ return super._init(context, propertiesJson, additionalInitParameters);
41
+ }
42
+ /**
43
+ * @internal
44
+ */ _internalRender() {
45
+ this.render();
46
+ }
47
+ /**
48
+ * Internal API to set form's display mode.
49
+ * @internal
50
+ */ _internalSetDisplayMode(newDisplayMode) {
51
+ this._displayMode = newDisplayMode;
52
+ }
53
+ /**
54
+ * Use this method to initiate saving of the form.
55
+ *
56
+ * @internal
57
+ */ _save() {
58
+ _SPEventManager.instance.raiseStickyEvent(BaseFormCustomizer._formActionEventName, new FormActionEventArgs(FormAction.Save));
59
+ }
60
+ /**
61
+ * Use this method to initiate closing/cancelling of the form.
62
+ *
63
+ * @internal
64
+ */ _close() {
65
+ _SPEventManager.instance.raiseStickyEvent(BaseFormCustomizer._formActionEventName, new FormActionEventArgs(FormAction.Close));
66
+ }
67
+ /**
68
+ * Disposes the component.
69
+ *
70
+ * @remarks
71
+ * Please, do not override this method.
72
+ * Override the `onDispose` method instead.
73
+ */ dispose() {
74
+ _SPEventManager.instance.removeEvent(BaseFormCustomizer._formActionEventName);
75
+ super.dispose();
76
+ }
77
+ /**
78
+ * @internal
79
+ */ _initializeExtensionType() {
80
+ super._initializeExtensionType();
81
+ this.context._host.logEngagement('init');
82
+ }
83
+ /**
84
+ * Call this method after the form has been saved to inform the application that the form has been saved.
85
+ */ formSaved() {
86
+ this.context._host.onSave();
87
+ }
88
+ /**
89
+ * Call this method after the form has been closed/cancelled to inform the application that the form has been closed.
90
+ */ formClosed() {
91
+ this.context._host.onClose();
92
+ }
93
+ constructor(...args){
94
+ super(...args);
95
+ this._formActionEvent = new SPEvent(BaseFormCustomizer._formActionEventName);
96
+ }
97
+ }
98
+ /**
99
+ * SPEvent name when the form action should be performed.
100
+ *
101
+ * @internal
102
+ */ BaseFormCustomizer._formActionEventName = 'formCustomizer.formAction';
103
+ _ES5CompatibleClass(BaseFormCustomizer);
104
+ export default BaseFormCustomizer;
105
+
106
+ //# sourceMappingURL=./BaseFormCustomizer.js.map
@@ -0,0 +1,18 @@
1
+ import { SPEventArgs } from '@microsoft/sp-core-library';
2
+ export var FormAction;
3
+ (function(FormAction) {
4
+ FormAction[FormAction["Save"] = 0] = "Save";
5
+ FormAction[FormAction["Close"] = 1] = "Close";
6
+ })(FormAction || (FormAction = {}));
7
+ /**
8
+ * Arguments for the form close/save event.
9
+ *
10
+ * @internal
11
+ */ export class FormActionEventArgs extends SPEventArgs {
12
+ constructor(formAction){
13
+ super();
14
+ this.action = formAction;
15
+ }
16
+ }
17
+
18
+ //# sourceMappingURL=./FormActionEventArgs.js.map
@@ -0,0 +1,59 @@
1
+ import { ExtensionContext } from '@microsoft/sp-extension-base';
2
+ class FormCustomizerContext extends ExtensionContext {
3
+ /**
4
+ * The list associated with the form.
5
+ */ get list() {
6
+ return this._list;
7
+ }
8
+ /**
9
+ * The content type associated with the form.
10
+ */ get contentType() {
11
+ return this._contentType;
12
+ }
13
+ /**
14
+ * The folder information where the item is located/should be created.
15
+ */ get folderInfo() {
16
+ return this._folderInfo;
17
+ }
18
+ /**
19
+ * The item id of the item being edited or viewed.
20
+ */ get itemId() {
21
+ return this._itemId;
22
+ }
23
+ /**
24
+ * The item data of the item being edited or viewed.
25
+ */ get item() {
26
+ return this._item;
27
+ }
28
+ /**
29
+ * The root DOM element of the form. This is a DIV element container for the custom form.
30
+ */ get domElement() {
31
+ return this._domElement;
32
+ }
33
+ /**
34
+ * Form host to interact with the host application.
35
+ *
36
+ * @internal
37
+ */ get _host() {
38
+ return this._formCustomizerHost;
39
+ }
40
+ /**
41
+ * @internal
42
+ */ constructor(extensionContextParameters, formCustomizerContextParameters){
43
+ super(extensionContextParameters);
44
+ this._list = formCustomizerContextParameters.list;
45
+ this._contentType = formCustomizerContextParameters.contentType;
46
+ this._folderInfo = formCustomizerContextParameters.folderInfo;
47
+ this._itemId = formCustomizerContextParameters.itemId;
48
+ this._item = formCustomizerContextParameters.item;
49
+ this._domElement = formCustomizerContextParameters.domElement;
50
+ this._formCustomizerHost = formCustomizerContextParameters.host;
51
+ }
52
+ }
53
+ /**
54
+ * Form Customizer Context. This object contains contextual services and properties for the form.
55
+ *
56
+ * @public
57
+ */ export { FormCustomizerContext as default };
58
+
59
+ //# sourceMappingURL=./FormCustomizerContext.js.map
@@ -0,0 +1,47 @@
1
+ /**
2
+ * Host parameters
3
+ *
4
+ * @internal
5
+ */ /**
6
+ * Form Customizer Host
7
+ *
8
+ * @internal
9
+ */ export class FormCustomizerHost {
10
+ /**
11
+ * The host will invoke this._onSaveCallback to inform the application on form save.
12
+ */ onSave() {
13
+ this.logEngagement('onSave');
14
+ this._onSaveCallback();
15
+ }
16
+ /**
17
+ * The host will invoke this._onCloseCallback to inform the application on form close.
18
+ */ onClose() {
19
+ this.logEngagement('onClose');
20
+ this._onCloseCallback();
21
+ }
22
+ /**
23
+ * The host will invoke this._onErrorCallback to inform the application on form error.
24
+ * @param error - Error message
25
+ */ onError(error) {
26
+ this.logEngagement('onError');
27
+ if (this._onErrorCallback) {
28
+ this._onErrorCallback(error);
29
+ }
30
+ }
31
+ /**
32
+ * Logs form engagement event
33
+ * @param eventName - Event name
34
+ */ logEngagement(eventName) {
35
+ if (this._logEngagement) {
36
+ this._logEngagement(eventName);
37
+ }
38
+ }
39
+ constructor(params){
40
+ this._onSaveCallback = params.onSaveCallback;
41
+ this._onCloseCallback = params.onCloseCallback;
42
+ this._onErrorCallback = params.onErrorCallback;
43
+ this._logEngagement = params.logEngagement;
44
+ }
45
+ }
46
+
47
+ //# sourceMappingURL=./FormCustomizerHost.js.map
@@ -2,8 +2,7 @@
2
2
  * SharePoint Framework support for customizing the list view.
3
3
  *
4
4
  * @packagedocumentation
5
- */
6
- export { default as BaseListViewCommandSet } from './commandSet/BaseListViewCommandSet';
5
+ */ export { default as BaseListViewCommandSet } from './commandSet/BaseListViewCommandSet';
7
6
  export { default as Command } from './commandSet/Command';
8
7
  export { default as ListViewCommandSetContext } from './commandSet/ListViewCommandSetContext';
9
8
  export { default as BaseFieldCustomizer } from './fieldCustomizer/BaseFieldCustomizer';
@@ -15,4 +14,5 @@ export { FormActionEventArgs as _FormActionEventArgs, FormAction as _FormAction
15
14
  export { default as ListItemAccessor } from './common/ListItemAccessor';
16
15
  export { ColumnAccessor, RowAccessor, SelectedRowsChangedEventArgs, ListViewStateChangedEventArgs, default as ListViewAccessor } from './common/ListViewAccessor';
17
16
  export { ListViewAccessorStateChanges } from './common/ListViewAccessorState';
18
- //# sourceMappingURL=index.js.map
17
+
18
+ //# sourceMappingURL=./index.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@microsoft/sp-listview-extensibility",
3
- "version": "1.23.1",
3
+ "version": "1.24.0-beta.2",
4
4
  "description": "SharePoint Framework developer support for customizing the list view",
5
5
  "homepage": "http://aka.ms/spfx",
6
6
  "license": "https://aka.ms/spfx/license",
@@ -11,21 +11,48 @@
11
11
  "node": ">=18.17.1 <19.0.0 || >=22.14.0 < 23.0.0"
12
12
  },
13
13
  "main": "lib-commonjs/index.js",
14
- "module": "lib/index.js",
14
+ "module": "lib-esm/index.js",
15
15
  "typings": "dist/index-internal.d.ts",
16
+ "exports": {
17
+ ".": {
18
+ "types": "./dist/index-internal.d.ts",
19
+ "import": "./lib-esm/index.js",
20
+ "require": "./lib-commonjs/index.js"
21
+ },
22
+ "./lib/*.resx": "./lib-esm/*.resx.json",
23
+ "./lib/*": {
24
+ "types": "./lib-dts/*.d.ts",
25
+ "import": "./lib-esm/*.js",
26
+ "require": "./lib-commonjs/*.js"
27
+ },
28
+ "./lib-commonjs/*.resx": "./lib-esm/*.resx.json",
29
+ "./lib-commonjs/*": {
30
+ "types": "./lib-dts/*.d.ts",
31
+ "import": "./lib-esm/*.js",
32
+ "require": "./lib-commonjs/*.js"
33
+ },
34
+ "./package.json": "./package.json"
35
+ },
36
+ "typesVersions": {
37
+ "*": {
38
+ "lib/*": [
39
+ "lib-dts/*"
40
+ ]
41
+ }
42
+ },
16
43
  "dependencies": {
17
44
  "@swc/helpers": "^0.5.12",
18
45
  "tslib": "2.3.1",
19
- "@microsoft/sp-extension-base": "1.23.1",
20
- "@microsoft/sp-core-library": "1.23.1",
21
- "@microsoft/sp-module-interfaces": "1.23.1",
22
- "@microsoft/sp-page-context": "1.23.1"
46
+ "@microsoft/sp-core-library": "1.24.0-beta.2",
47
+ "@microsoft/sp-extension-base": "1.24.0-beta.2",
48
+ "@microsoft/sp-module-interfaces": "1.24.0-beta.2",
49
+ "@microsoft/sp-page-context": "1.24.0-beta.2"
23
50
  },
24
51
  "devDependencies": {
25
52
  "@rushstack/heft": "1.2.17",
26
53
  "eslint": "9.37.0",
27
- "@microsoft/sp-odata-types": "1.23.1",
28
- "@msinternal/spfx-internal-web-build-rig": "0.1.0"
54
+ "@msinternal/spfx-internal-web-build-rig": "0.1.0",
55
+ "@microsoft/sp-odata-types": "1.24.0-beta.2"
29
56
  },
30
57
  "scripts": {
31
58
  "build": "heft test --clean",
@@ -1 +0,0 @@
1
- define("d37b65ee-c7d8-4570-bc74-2b294ff3b380_1.23.1",["tslib","@microsoft/sp-core-library","@microsoft/sp-extension-base","@microsoft/sp-page-context"],(e,t,n,a)=>(()=>{"use strict";var i={676(e){e.exports=t},0(e){e.exports=n},408(e){e.exports=a},280(t){t.exports=e}},r={};function o(e){var t=r[e];if(void 0!==t)return t.exports;var n=r[e]={exports:{}};return i[e](n,n.exports,o),n.exports}o.d=(e,t)=>{for(var n in t)o.o(t,n)&&!o.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:t[n]})},o.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),o.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var s={};return(()=>{o.r(s),o.d(s,{BaseFieldCustomizer:()=>u,BaseFormCustomizer:()=>h,BaseListViewCommandSet:()=>i,ColumnAccessor:()=>y,Command:()=>r,FieldCustomizerContext:()=>f,FormCustomizerContext:()=>b,ListItemAccessor:()=>v,ListViewAccessor:()=>x,ListViewAccessorStateChanges:()=>C,ListViewCommandSetContext:()=>d,ListViewStateChangedEventArgs:()=>I,RowAccessor:()=>S,SelectedRowsChangedEventArgs:()=>D,_FormAction:()=>p,_FormActionEventArgs:()=>m,_FormCustomizerHost:()=>g});var e=o(280),t=o(676),n=o(0),a=function(n){function a(){var e=null!==n&&n.apply(this,arguments)||this;return e._raiseOnChange=void 0,e}return(0,e.__extends)(a,n),a.prototype.tryGetCommand=function(e){return t.Validate.isNonemptyString(e,"id"),this.context._commands.filter(function(t){return t.id===e})[0]},a.prototype.onListViewUpdated=function(e){},a.prototype.onExecute=function(e){},a.prototype.raiseOnChange=function(){this._raiseOnChange&&this._raiseOnChange()},a}(n.BaseExtension);(0,t._ES5CompatibleClass)(a);const i=a,r=function(){};var c=o(408);const d=function(n){function a(e,a){var i=n.call(this,e)||this;i._listView=a.listView,i._commandArray=[];for(var r=i.manifest.items,o=0,s=Object.keys(r);o<s.length;o++){var d=s[o];if(t._SPFlight.isEnabled(62894)?"command"===r[d].type||"group"===r[d].type:"command"===r[d].type){var l=r[d].iconImageUrl;l&&!t.UrlUtilities.isDataUrl(l)&&(l=t.UrlUtilities.resolve(l,i.manifest.loaderConfig.internalModuleBaseUrls[0])),i._commandArray.push({id:d,title:r[d].title.default||"",ariaLabel:r[d].ariaLabel?r[d].ariaLabel.default:void 0,iconImageUrl:l,visible:!0,disabled:void 0})}}return i._commandArray.length&&i.serviceScope.whenFinished(function(){var e=i.serviceScope.consume(c.PageContext.serviceKey).cultureInfo.currentUICultureName;i._commandArray.forEach(function(n){var a=r[n.id];n.title=t.Text._getLocalizedString(a.title,e)||"",a.ariaLabel&&(n.ariaLabel=t.Text._getLocalizedString(a.ariaLabel,e))})}),i}return(0,e.__extends)(a,n),Object.defineProperty(a.prototype,"listView",{get:function(){return this._listView},enumerable:!1,configurable:!0}),Object.defineProperty(a.prototype,"_commands",{get:function(){return this._commandArray},enumerable:!1,configurable:!0}),a}(n.ExtensionContext);var l=function(t){function n(){return null!==t&&t.apply(this,arguments)||this}return(0,e.__extends)(n,t),n.prototype.onRenderCell=function(e){var t="".concat(e.fieldValue);e.fieldValue.innerText=t},n.prototype.onDisposeCell=function(e){},n}(n.BaseExtension);(0,t._ES5CompatibleClass)(l);const u=l,f=function(t){function n(e,n){var a=t.call(this,e)||this;return a._listView=n.listView,a._field=n.field,a}return(0,e.__extends)(n,t),n.prototype.tryGetListView=function(){return this._listView},Object.defineProperty(n.prototype,"field",{get:function(){return this._field},enumerable:!1,configurable:!0}),n}(n.ExtensionContext);var p;!function(e){e[e.Save=0]="Save",e[e.Close=1]="Close"}(p||(p={}));var m=function(t){function n(e){var n=t.call(this)||this;return n.action=e,n}return(0,e.__extends)(n,t),n}(t.SPEventArgs),_=function(n){function a(){var e=null!==n&&n.apply(this,arguments)||this;return e._formActionEvent=new t.SPEvent(a._formActionEventName),e}return(0,e.__extends)(a,n),Object.defineProperty(a.prototype,"domElement",{get:function(){return this.context.domElement},enumerable:!1,configurable:!0}),Object.defineProperty(a.prototype,"displayMode",{get:function(){return this._displayMode},enumerable:!1,configurable:!0}),Object.defineProperty(a.prototype,"formActionEvent",{get:function(){return this._formActionEvent},enumerable:!1,configurable:!0}),a.prototype._init=function(e,t,a){return a&&(this._displayMode=a.displayMode),n.prototype._init.call(this,e,t,a)},a.prototype._internalRender=function(){this.render()},a.prototype._internalSetDisplayMode=function(e){this._displayMode=e},a.prototype._save=function(){t._SPEventManager.instance.raiseStickyEvent(a._formActionEventName,new m(p.Save))},a.prototype._close=function(){t._SPEventManager.instance.raiseStickyEvent(a._formActionEventName,new m(p.Close))},a.prototype.dispose=function(){t._SPEventManager.instance.removeEvent(a._formActionEventName),n.prototype.dispose.call(this)},a.prototype._initializeExtensionType=function(){n.prototype._initializeExtensionType.call(this),this.context._host.logEngagement("init")},a.prototype.formSaved=function(){this.context._host.onSave()},a.prototype.formClosed=function(){this.context._host.onClose()},a._formActionEventName="formCustomizer.formAction",a}(n.BaseExtension);(0,t._ES5CompatibleClass)(_);const h=_,b=function(t){function n(e,n){var a=t.call(this,e)||this;return a._list=n.list,a._contentType=n.contentType,a._folderInfo=n.folderInfo,a._itemId=n.itemId,a._item=n.item,a._domElement=n.domElement,a._formCustomizerHost=n.host,a}return(0,e.__extends)(n,t),Object.defineProperty(n.prototype,"list",{get:function(){return this._list},enumerable:!1,configurable:!0}),Object.defineProperty(n.prototype,"contentType",{get:function(){return this._contentType},enumerable:!1,configurable:!0}),Object.defineProperty(n.prototype,"folderInfo",{get:function(){return this._folderInfo},enumerable:!1,configurable:!0}),Object.defineProperty(n.prototype,"itemId",{get:function(){return this._itemId},enumerable:!1,configurable:!0}),Object.defineProperty(n.prototype,"item",{get:function(){return this._item},enumerable:!1,configurable:!0}),Object.defineProperty(n.prototype,"domElement",{get:function(){return this._domElement},enumerable:!1,configurable:!0}),Object.defineProperty(n.prototype,"_host",{get:function(){return this._formCustomizerHost},enumerable:!1,configurable:!0}),n}(n.ExtensionContext);var g=function(){function e(e){this._onSaveCallback=e.onSaveCallback,this._onCloseCallback=e.onCloseCallback,this._onErrorCallback=e.onErrorCallback,this._logEngagement=e.logEngagement}return e.prototype.onSave=function(){this.logEngagement("onSave"),this._onSaveCallback()},e.prototype.onClose=function(){this.logEngagement("onClose"),this._onCloseCallback()},e.prototype.onError=function(e){this.logEngagement("onError"),this._onErrorCallback&&this._onErrorCallback(e)},e.prototype.logEngagement=function(e){this._logEngagement&&this._logEngagement(e)},e}();const v=function(){};var y=function(){},S=function(t){function n(){return t.call(this)||this}return(0,e.__extends)(n,t),n}(v),D=function(t){function n(){return null!==t&&t.apply(this,arguments)||this}return(0,e.__extends)(n,t),n}(t.SPEventArgs),I=function(t){function n(){return null!==t&&t.apply(this,arguments)||this}return(0,e.__extends)(n,t),n}(t.SPEventArgs);const x=function(){function e(n){this._isDisposed=!1,this._selectedRowsChangedEvent=new t.SPEvent(e._selectedRowsChangedEventName),this._listViewStateChangedEventName="".concat(e._listViewStateChangedEventName).concat(n||""),this._listViewStateChangedEvent=new t.SPEvent(this._listViewStateChangedEventName)}return Object.defineProperty(e.prototype,"selectedRowsChangedEvent",{get:function(){return this._selectedRowsChangedEvent},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"listViewStateChangedEvent",{get:function(){return this._listViewStateChangedEvent},enumerable:!1,configurable:!0}),e.prototype.dispose=function(){t._SPEventManager.instance.removeEvent(this._listViewStateChangedEventName),this._isDisposed=!0},Object.defineProperty(e.prototype,"isDisposed",{get:function(){return this._isDisposed},enumerable:!1,configurable:!0}),e._selectedRowsChangedEventName="listView.selectedRowsChanged",e._listViewStateChangedEventName="listView.stateChanged",e}();var C;!function(e){e[e.None=0]="None",e[e.List=1]="List",e[e.View=2]="View",e[e.Columns=4]="Columns",e[e.SelectedRows=8]="SelectedRows",e[e.Rows=16]="Rows",e[e.AppliedFilters=32]="AppliedFilters",e[e.Sort=64]="Sort",e[e.FolderInfo=128]="FolderInfo"}(C||(C={}))})(),s})());
@@ -1 +0,0 @@
1
- {"version":3,"file":"BaseListViewCommandSet.d.ts","sourceRoot":"","sources":["../../src/commandSet/BaseListViewCommandSet.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAE7D,OAAO,KAAK,yBAAyB,MAAM,6BAA6B,CAAC;AACzE,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AAErC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAE9D;;;;GAIG;AACH,MAAM,WAAW,4CAA4C;IAC3D;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;CACnD;AAED;;;;GAIG;AACH,MAAM,WAAW,yCAAyC;IACxD;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;CACnD;AAED;;;;;;;;;;;;;GAaG;AACH,uBAAe,sBAAsB,CAAC,WAAW,CAAE,SAAQ,aAAa,CAAC,WAAW,CAAC;IACnF;;OAEG;IAEH,SAAgB,OAAO,EAAG,yBAAyB,CAAC;IAEpD;;OAEG;IACI,cAAc,CAAC,EAAE,MAAM,IAAI,CAAa;IAE/C;;;;OAIG;IACI,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAMzC;;;;;;;OAOG;IACI,iBAAiB,CAAC,KAAK,EAAE,4CAA4C,GAAG,IAAI;IAInF;;;;OAIG;IACI,SAAS,CAAC,KAAK,EAAE,yCAAyC,GAAG,IAAI;IAIxE;;OAEG;IACI,aAAa,IAAI,IAAI;CAK7B;AAID,eAAe,sBAAsB,CAAC"}
@@ -1,69 +0,0 @@
1
- import { __extends } from "tslib";
2
- import { Validate, _ES5CompatibleClass } from '@microsoft/sp-core-library';
3
- import { BaseExtension } from '@microsoft/sp-extension-base';
4
- /**
5
- * This is the base class that third parties should extend when implementing
6
- * a client-side extension that provides a command set for a SharePoint list view.
7
- *
8
- * @remarks
9
- * In the component manifest, the "extensionType" should be set to "ListViewCommandSet".
10
- *
11
- * @privateRemarks
12
- *
13
- * Eventually other command set classes will be introduced, and then we will introduce a base class
14
- * so the hierarchy goes `BaseListViewCommandSet <- BaseCommandSet <- BaseExtension <- BaseComponent`.
15
- *
16
- * @public
17
- */
18
- var BaseListViewCommandSet = /** @class */ (function (_super) {
19
- __extends(BaseListViewCommandSet, _super);
20
- function BaseListViewCommandSet() {
21
- var _this = _super !== null && _super.apply(this, arguments) || this;
22
- /**
23
- * @internal
24
- */
25
- _this._raiseOnChange = undefined; // provided by Command set adapter
26
- return _this;
27
- }
28
- /**
29
- * Returns the command with the given id.
30
- * Returns undefined if there is not command with the given id.
31
- * @param id - Id of the command
32
- */
33
- BaseListViewCommandSet.prototype.tryGetCommand = function (id) {
34
- Validate.isNonemptyString(id, 'id');
35
- var commands = this.context._commands.filter(function (command) { return command.id === id; });
36
- return commands[0];
37
- };
38
- /**
39
- * This event occurs whenever the ListView state changes.
40
- * virtual
41
- * @remarks
42
- * This event allows the implementor to tailor the visibility of the command.
43
- *
44
- * @deprecated Use context.listView.listViewStateChangedEvent instead.
45
- */
46
- BaseListViewCommandSet.prototype.onListViewUpdated = function (event) {
47
- // (implemented by child class)
48
- };
49
- /**
50
- * This event occurs when the command is invoked, e.g. because the user
51
- * clicked on the toolbar button or menu item.
52
- * virtual
53
- */
54
- BaseListViewCommandSet.prototype.onExecute = function (event) {
55
- // (implemented by child class)
56
- };
57
- /**
58
- * Use this method to fire OnChange event and initialize a reflow of the ListView.
59
- */
60
- BaseListViewCommandSet.prototype.raiseOnChange = function () {
61
- if (this._raiseOnChange) {
62
- this._raiseOnChange();
63
- }
64
- };
65
- return BaseListViewCommandSet;
66
- }(BaseExtension));
67
- _ES5CompatibleClass(BaseListViewCommandSet);
68
- export default BaseListViewCommandSet;
69
- //# sourceMappingURL=BaseListViewCommandSet.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"Command.d.ts","sourceRoot":"","sources":["../../src/commandSet/Command.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,OAAO,OAAO;IAC1B;;OAEG;IACI,EAAE,EAAG,MAAM,CAAC;IAEnB;;;;;;;;;OASG;IACI,KAAK,EAAG,MAAM,CAAC;IAEtB;;;;;;OAMG;IACI,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAExC;;;;OAIG;IACI,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAErC;;OAEG;IACI,OAAO,EAAG,OAAO,CAAC;IAEzB;;OAEG;IACI,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;CACtC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"ListViewCommandSetContext.d.ts","sourceRoot":"","sources":["../../src/commandSet/ListViewCommandSetContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,KAAK,4BAA4B,EAAE,MAAM,8BAA8B,CAAC;AACnG,OAAO,KAAK,EACV,4BAA4B,EAG7B,MAAM,iCAAiC,CAAC;AAGzC,OAAO,KAAK,gBAAgB,MAAM,4BAA4B,CAAC;AAC/D,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AAIrC;;;;GAIG;AACH,MAAM,WAAW,oCAAoC;IACnD,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;CACrC;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,yBAA0B,SAAQ,gBAAgB;IACrE;;OAEG;IACH,SAAgB,QAAQ,EAAG,4BAA4B,CAAC;IACxD,OAAO,CAAC,SAAS,CAAmB;IACpC,OAAO,CAAC,aAAa,CAAY;IAEjC;;OAEG;gBAED,0BAA0B,EAAE,4BAA4B,EACxD,mCAAmC,EAAE,oCAAoC;IAmD3E;;OAEG;IACH,IAAW,QAAQ,IAAI,gBAAgB,CAEtC;IAED;;;;;;;;OAQG;IACH,IAAW,SAAS,IAAI,aAAa,CAAC,OAAO,CAAC,CAE7C;CACF"}