@microsoft/sp-listview-extensibility 1.22.0-beta.2 → 1.22.0-beta.3

package/lib/common/ListViewAccessor.js

@@ -0,0 +1,146 @@
+import { __extends } from "tslib";
+import { SPEvent, SPEventArgs, _SPEventManager } from '@microsoft/sp-core-library';
+import ListItemAccessor from './ListItemAccessor';
+/**
+ * Provides access to a ListView column, which is the visual presentation
+ * of a field.
+ *
+ * @remarks
+ *
+ * A SharePoint "field" (SPField) defines the data storage for a property of a list item.
+ * (If the list item represents a document, then the field is sometimes called a "property".)
+ *
+ * A "column" is the visual presentation of a field, when displayed by the ListView.
+ *
+ * @public
+ */
+var ColumnAccessor = /** @class */ (function () {
+    /** @internal */
+    function ColumnAccessor() {
+        // (mark constructor as internal)
+    }
+    return ColumnAccessor;
+}());
+export { ColumnAccessor };
+/**
+ * Provides access to a ListView row, which is the visual presentation
+ * of a SharePoint list item.
+ *
+ * @remarks
+ *
+ * A SharePoint "list item" (SPListItem) is a data storage record in the content
+ * management system; it stores an array of values for the associated fields.
+ *
+ * A "row" is the visual presentation of a list item, when displayed by the ListView;
+ * it stores an array of cell values for the associated columns.
+ *
+ * @public
+ */
+var RowAccessor = /** @class */ (function (_super) {
+    __extends(RowAccessor, _super);
+    /**
+     * @internal
+     */
+    function RowAccessor() {
+        return _super.call(this) || this;
+    }
+    return RowAccessor;
+}(ListItemAccessor));
+export { RowAccessor };
+/**
+ * Arguments for the selected rows changed event.
+ *
+ * @public
+ */
+var SelectedRowsChangedEventArgs = /** @class */ (function (_super) {
+    __extends(SelectedRowsChangedEventArgs, _super);
+    function SelectedRowsChangedEventArgs() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return SelectedRowsChangedEventArgs;
+}(SPEventArgs));
+export { SelectedRowsChangedEventArgs };
+/**
+ * Arguments for the list view state changed event.
+ *
+ * @public
+ */
+var ListViewStateChangedEventArgs = /** @class */ (function (_super) {
+    __extends(ListViewStateChangedEventArgs, _super);
+    function ListViewStateChangedEventArgs() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return ListViewStateChangedEventArgs;
+}(SPEventArgs));
+export { ListViewStateChangedEventArgs };
+/**
+ * Provides access to a SharePoint ListView control.
+ *
+ * @public
+ */
+var ListViewAccessor = /** @class */ (function () {
+    /**
+     * @internal
+     */
+    function ListViewAccessor(eventPrefix) {
+        this._isDisposed = false;
+        this._selectedRowsChangedEvent = new SPEvent(ListViewAccessor._selectedRowsChangedEventName);
+        this._listViewStateChangedEventName = "".concat(ListViewAccessor._listViewStateChangedEventName).concat(eventPrefix || '');
+        this._listViewStateChangedEvent = new SPEvent(this._listViewStateChangedEventName);
+    }
+    Object.defineProperty(ListViewAccessor.prototype, "selectedRowsChangedEvent", {
+        /**
+         * Event that gets raised every time the selected items in the list view change.
+         * @eventproperty
+         */
+        get: function () {
+            return this._selectedRowsChangedEvent;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ListViewAccessor.prototype, "listViewStateChangedEvent", {
+        /**
+         * Event that gets raised every time the list view state changes.
+         *
+         * @eventproperty
+         */
+        get: function () {
+            return this._listViewStateChangedEvent;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * @internal
+     */
+    ListViewAccessor.prototype.dispose = function () {
+        _SPEventManager.instance.removeEvent(this._listViewStateChangedEventName);
+        this._isDisposed = true;
+    };
+    Object.defineProperty(ListViewAccessor.prototype, "isDisposed", {
+        /**
+         * @internal
+         */
+        get: function () {
+            return this._isDisposed;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * SPEvent name when the selected rows in a list have changed.
+     *
+     * @internal
+     */
+    ListViewAccessor._selectedRowsChangedEventName = 'listView.selectedRowsChanged';
+    /**
+     * SPEvent name when the list view state has changed.
+     *
+     * @internal
+     */
+    ListViewAccessor._listViewStateChangedEventName = 'listView.stateChanged';
+    return ListViewAccessor;
+}());
+export default ListViewAccessor;
+//# sourceMappingURL=ListViewAccessor.js.map

package/lib/common/ListViewAccessorState.d.ts

@@ -0,0 +1,207 @@
+import type { Guid } from '@microsoft/sp-core-library';
+/**
+ * Describes the type of list view state changes.
+ *
+ * @public
+ */
+export declare enum ListViewAccessorStateChanges {
+    None = 0,
+    List = 1,
+    View = 2,
+    Columns = 4,
+    SelectedRows = 8,
+    Rows = 16,
+    AppliedFilters = 32,
+    Sort = 64,
+    FolderInfo = 128
+}
+/**
+ * Provides information about the state of a column in the list view
+ *
+ * @public
+ */
+export interface IColumn {
+    /**
+     * The GUID identifier for this field.
+     */
+    readonly id: Guid;
+    /**
+     * The internal name of the field. This name is usually used to find the field.
+     */
+    readonly internalName: string;
+    /**
+     * The type of the field represented as a string
+     */
+    readonly fieldType: string;
+    /**
+     * Whether the field is required for each list item in the list
+     */
+    readonly isRequired: boolean;
+    /**
+     * Whether the column is visible in the view
+     */
+    readonly isVisible: boolean;
+    /**
+     * The display name of the field. This name is shown as column name in UI.
+     */
+    readonly displayName: string;
+    /**
+     * The unique identifier of the client-side component associated with the field.
+     */
+    readonly clientSideComponentId: Guid | undefined;
+    /**
+     * This property is only used when a `ClientSideComponentId` is specified.  It is optional.
+     *
+     * @remarks
+     * If non-empty, the string must contain a JSON object with custom initialization properties
+     * whose format and meaning are defined by the client-side component.
+     */
+    readonly clientSideComponentProperties: string;
+}
+/**
+ * Provides information about the list item's state rendered by the ListView.
+ *
+ * @public
+ */
+export interface IRow {
+    /**
+     * A map of column values for the row. They key is the column internal name and the value
+     * is its corresponding value in the row.
+     */
+    readonly values: {
+        [columnInternalName: string]: Readonly<any>;
+    };
+}
+/**
+ * Provides information about the state of the filters applied to the ListView.
+ *
+ * @public
+ */
+export interface IFilter {
+    /**
+     * Field name to filter on.
+     */
+    readonly fieldName: string;
+    /**
+     * Values to filter on.
+     */
+    values: ReadonlyArray<string>;
+}
+/**
+ * Provides information about the state of the folder in the ListView.
+ *
+ * @public
+ */
+export interface IFolderInfo {
+    /**
+     * Folder path.
+     */
+    readonly folderPath: string;
+}
+/**
+ * Provides information about the list rendered by the ListView.
+ *
+ * @public
+ */
+export interface IList {
+    /**
+     * List id.
+     */
+    readonly guid: Guid;
+    /**
+     * List title.
+     */
+    readonly title: string;
+    /**
+     * List server relative url.
+     */
+    readonly serverRelativeUrl: string;
+}
+/**
+ * Provides information about the view rendered by the ListView.
+ *
+ * @public
+ */
+export interface IView {
+    /**
+     * View id.
+     */
+    readonly id: Guid;
+    /**
+     * View title.
+     */
+    readonly title: string;
+    /**
+     * View server relative url.
+     */
+    readonly url: string;
+}
+/**
+ * Provides information about the state of the ListView.
+ *
+ * @public
+ */
+export interface IListViewAccessorState {
+    /**
+     * List information.
+     */
+    readonly list?: IList;
+    /**
+     * View information.
+     */
+    readonly view?: IView;
+    /**
+     * Current folder information.
+     */
+    readonly folderInfo?: IFolderInfo;
+    /**
+     * Columns information.
+     */
+    readonly columns: ReadonlyArray<IColumn>;
+    /**
+     * Selected rows information.
+     */
+    readonly selectedRows?: ReadonlyArray<IRow>;
+    /**
+     * Rows information.
+     */
+    readonly rows: ReadonlyArray<IRow>;
+    /**
+     * Applied filters information.
+     */
+    readonly appliedFilters?: {
+        [fieldName: string]: IFilter;
+    };
+    /**
+     * Sort field name.
+     */
+    readonly sortField?: string;
+    /**
+     * Sort direction.
+     */
+    readonly sortAscending?: boolean;
+}
+/**
+ * Provides information about the content type
+ *
+ * @public
+ */
+export interface IContentType {
+    /**
+     * Content type string id
+     */
+    readonly id: string;
+    /**
+     * Content type name
+     */
+    readonly name: string;
+    /**
+     * Custom formatter JSON for the form
+     */
+    readonly ClientFormCustomFormatter: string | undefined;
+    /**
+     * Content type schema XML
+     */
+    readonly schemaXml: string | undefined;
+}
+//# sourceMappingURL=ListViewAccessorState.d.ts.map

package/lib/common/ListViewAccessorState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ListViewAccessorState.d.ts","sourceRoot":"","sources":["../../src/common/ListViewAccessorState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AAEvD;;;;GAIG;AACH,oBAAY,4BAA4B;IACtC,IAAI,IAAI;IACR,IAAI,IAAI;IACR,IAAI,IAAI;IACR,OAAO,IAAI;IACX,YAAY,IAAI;IAChB,IAAI,KAAK;IACT,cAAc,KAAK;IACnB,IAAI,KAAK;IACT,UAAU,MAAM;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,qBAAqB,EAAE,IAAI,GAAG,SAAS,CAAC;IAEjD;;;;;;OAMG;IACH,QAAQ,CAAC,6BAA6B,EAAE,MAAM,CAAC;CAChD;AAED;;;;GAIG;AACH,MAAM,WAAW,IAAI;IACnB;;;OAGG;IAEH,QAAQ,CAAC,MAAM,EAAE;QAAE,CAAC,kBAAkB,EAAE,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAA;KAAE,CAAC;CAClE;AAED;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,WAAW,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;IACzC;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;IAC5C;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;IACnC;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE;QAAE,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAC3D;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,yBAAyB,EAAE,MAAM,GAAG,SAAS,CAAC;IACvD;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;CACxC"}

package/lib/common/ListViewAccessorState.js

@@ -0,0 +1,18 @@
+/**
+ * Describes the type of list view state changes.
+ *
+ * @public
+ */
+export var ListViewAccessorStateChanges;
+(function (ListViewAccessorStateChanges) {
+    ListViewAccessorStateChanges[ListViewAccessorStateChanges["None"] = 0] = "None";
+    ListViewAccessorStateChanges[ListViewAccessorStateChanges["List"] = 1] = "List";
+    ListViewAccessorStateChanges[ListViewAccessorStateChanges["View"] = 2] = "View";
+    ListViewAccessorStateChanges[ListViewAccessorStateChanges["Columns"] = 4] = "Columns";
+    ListViewAccessorStateChanges[ListViewAccessorStateChanges["SelectedRows"] = 8] = "SelectedRows";
+    ListViewAccessorStateChanges[ListViewAccessorStateChanges["Rows"] = 16] = "Rows";
+    ListViewAccessorStateChanges[ListViewAccessorStateChanges["AppliedFilters"] = 32] = "AppliedFilters";
+    ListViewAccessorStateChanges[ListViewAccessorStateChanges["Sort"] = 64] = "Sort";
+    ListViewAccessorStateChanges[ListViewAccessorStateChanges["FolderInfo"] = 128] = "FolderInfo";
+})(ListViewAccessorStateChanges || (ListViewAccessorStateChanges = {}));
+//# sourceMappingURL=ListViewAccessorState.js.map

package/lib/fieldCustomizer/BaseFieldCustomizer.d.ts

@@ -0,0 +1,51 @@
+import { BaseExtension } from '@microsoft/sp-extension-base';
+import type FieldCustomizerContext from './FieldCustomizerContext';
+import type ListItemAccessor from '../common/ListItemAccessor';
+/**
+ * Event parameters for BaseFieldCustomizer.onRenderCell()
+ * @public
+ */
+export interface IFieldCustomizerCellEventParameters {
+    /**
+     * The HTML "div" element that the extension will take ownership of.
+     * This ownership will end when onDisposeCell() is called.
+     */
+    readonly domElement: HTMLDivElement;
+    /**
+     * The list item being edited.
+     */
+    readonly listItem: ListItemAccessor;
+    /**
+     * The value of the field being rendered.
+     */
+    readonly fieldValue: any;
+    /**
+     * An implementation defined storage property.
+     *
+     * @remarks
+     * For example, suppose that resources need to be allocated during rendering
+     * (e.g. a renderer object, an HTTP request to be canceled, a cache slot, etc).
+     * The onRenderCell() implementation could store a key or handle in this property,
+     * and then onDisposeCell() can use this key to find the resource to be freed.
+     */
+    userData: any;
+}
+/**
+ * This is the base class that third parties should extend when implementing
+ * a client-side extension that customizes the appearance of fields in
+ * a SharePoint ListView.
+ *
+ * In the component manifest, the "extensionType" should be set to "FieldCustomizer".
+ *
+ * @public
+ */
+declare abstract class BaseFieldCustomizer<TProperties> extends BaseExtension<TProperties> {
+    /**
+     * {@inheritDoc @microsoft/sp-component-base#BaseComponent.context}
+     */
+    protected readonly context: FieldCustomizerContext;
+    onRenderCell(event: IFieldCustomizerCellEventParameters): void;
+    onDisposeCell(event: IFieldCustomizerCellEventParameters): void;
+}
+export default BaseFieldCustomizer;
+//# sourceMappingURL=BaseFieldCustomizer.d.ts.map

package/lib/fieldCustomizer/BaseFieldCustomizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseFieldCustomizer.d.ts","sourceRoot":"","sources":["../../src/fieldCustomizer/BaseFieldCustomizer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,KAAK,sBAAsB,MAAM,0BAA0B,CAAC;AACnE,OAAO,KAAK,gBAAgB,MAAM,4BAA4B,CAAC;AAE/D;;;GAGG;AACH,MAAM,WAAW,mCAAmC;IAClD;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IAEpC;;OAEG;IAEH,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC;IAEzB;;;;;;;;OAQG;IAEH,QAAQ,EAAE,GAAG,CAAC;CACf;AAED;;;;;;;;GAQG;AACH,uBAAe,mBAAmB,CAAC,WAAW,CAAE,SAAQ,aAAa,CAAC,WAAW,CAAC;IAChF;;OAEG;IAEH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAG,sBAAsB,CAAC;IAK7C,YAAY,CAAC,KAAK,EAAE,mCAAmC,GAAG,IAAI;IAQ9D,aAAa,CAAC,KAAK,EAAE,mCAAmC,GAAG,IAAI;CAGvE;AAED,eAAe,mBAAmB,CAAC"}

package/lib/fieldCustomizer/BaseFieldCustomizer.js

@@ -0,0 +1,33 @@
+import { __extends } from "tslib";
+import { BaseExtension } from '@microsoft/sp-extension-base';
+/**
+ * This is the base class that third parties should extend when implementing
+ * a client-side extension that customizes the appearance of fields in
+ * a SharePoint ListView.
+ *
+ * In the component manifest, the "extensionType" should be set to "FieldCustomizer".
+ *
+ * @public
+ */
+var BaseFieldCustomizer = /** @class */ (function (_super) {
+    __extends(BaseFieldCustomizer, _super);
+    function BaseFieldCustomizer() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /*
+     * virtual
+     */
+    BaseFieldCustomizer.prototype.onRenderCell = function (event) {
+        var text = "".concat(event.fieldValue);
+        event.fieldValue.innerText = text;
+    };
+    /*
+     * virtual
+     */
+    BaseFieldCustomizer.prototype.onDisposeCell = function (event) {
+        // (implemented by child class)
+    };
+    return BaseFieldCustomizer;
+}(BaseExtension));
+export default BaseFieldCustomizer;
+//# sourceMappingURL=BaseFieldCustomizer.js.map

package/lib/fieldCustomizer/FieldCustomizerContext.d.ts

@@ -0,0 +1,41 @@
+import type { SPField } from '@microsoft/sp-page-context';
+import { ExtensionContext, type _IExtensionContextParameters } from '@microsoft/sp-extension-base';
+import type ListViewAccessor from '../common/ListViewAccessor';
+/**
+ * Constructor parameters for FieldCustomizerContext.
+ *
+ * @internal
+ */
+export interface IFieldCustomizerContextParameters {
+    readonly listView: ListViewAccessor | undefined;
+    readonly field: SPField;
+}
+/**
+ * This object provides contextual information for BaseFieldCustomizer.
+ * @public
+ */
+export default class FieldCustomizerContext extends ExtensionContext {
+    private _listView;
+    private _field;
+    /**
+     * @internal
+     */
+    constructor(extensionContextParameters: _IExtensionContextParameters, fieldCustomizerContextParameters: IFieldCustomizerContextParameters);
+    /**
+     * If the field customizer is bounded to the SharePoint list view, this provides access
+     * to the list view specific functionality; otherwise the value is undefined.
+     *
+     * @remarks
+     * Although the SharePoint list view is the main usage scenario, field customizers
+     * can be used by other user interface surfaces.  For example, in the future SharePoint
+     * may support field customizers on a display/edit form.
+     *
+     * @returns the SharePoint list view, or undefined if there is none.
+     */
+    tryGetListView(): ListViewAccessor | undefined;
+    /**
+     * Provides access to the SharePoint field that the customizer will operate on.
+     */
+    get field(): SPField;
+}
+//# sourceMappingURL=FieldCustomizerContext.d.ts.map

package/lib/fieldCustomizer/FieldCustomizerContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FieldCustomizerContext.d.ts","sourceRoot":"","sources":["../../src/fieldCustomizer/FieldCustomizerContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,KAAK,4BAA4B,EAAE,MAAM,8BAA8B,CAAC;AAEnG,OAAO,KAAK,gBAAgB,MAAM,4BAA4B,CAAC;AAE/D;;;;GAIG;AACH,MAAM,WAAW,iCAAiC;IAChD,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAChD,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,sBAAuB,SAAQ,gBAAgB;IAClE,OAAO,CAAC,SAAS,CAA+B;IAChD,OAAO,CAAC,MAAM,CAAU;IAExB;;OAEG;gBAED,0BAA0B,EAAE,4BAA4B,EACxD,gCAAgC,EAAE,iCAAiC;IAQrE;;;;;;;;;;OAUG;IACI,cAAc,IAAI,gBAAgB,GAAG,SAAS;IAIrD;;OAEG;IACH,IAAW,KAAK,IAAI,OAAO,CAE1B;CACF"}

package/lib/fieldCustomizer/FieldCustomizerContext.js

@@ -0,0 +1,45 @@
+import { __extends } from "tslib";
+import { ExtensionContext } from '@microsoft/sp-extension-base';
+/**
+ * This object provides contextual information for BaseFieldCustomizer.
+ * @public
+ */
+var FieldCustomizerContext = /** @class */ (function (_super) {
+    __extends(FieldCustomizerContext, _super);
+    /**
+     * @internal
+     */
+    function FieldCustomizerContext(extensionContextParameters, fieldCustomizerContextParameters) {
+        var _this = _super.call(this, extensionContextParameters) || this;
+        _this._listView = fieldCustomizerContextParameters.listView;
+        _this._field = fieldCustomizerContextParameters.field;
+        return _this;
+    }
+    /**
+     * If the field customizer is bounded to the SharePoint list view, this provides access
+     * to the list view specific functionality; otherwise the value is undefined.
+     *
+     * @remarks
+     * Although the SharePoint list view is the main usage scenario, field customizers
+     * can be used by other user interface surfaces.  For example, in the future SharePoint
+     * may support field customizers on a display/edit form.
+     *
+     * @returns the SharePoint list view, or undefined if there is none.
+     */
+    FieldCustomizerContext.prototype.tryGetListView = function () {
+        return this._listView;
+    };
+    Object.defineProperty(FieldCustomizerContext.prototype, "field", {
+        /**
+         * Provides access to the SharePoint field that the customizer will operate on.
+         */
+        get: function () {
+            return this._field;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return FieldCustomizerContext;
+}(ExtensionContext));
+export default FieldCustomizerContext;
+//# sourceMappingURL=FieldCustomizerContext.js.map

package/lib/formCustomizer/BaseFormCustomizer.d.ts

@@ -0,0 +1,102 @@
+import { BaseExtension, type ExtensionContext, type _IAdditionalInitParameters } from '@microsoft/sp-extension-base';
+import { type FormDisplayMode, SPEvent } from '@microsoft/sp-core-library';
+import type FormCustomizerContext from './FormCustomizerContext';
+import { FormActionEventArgs } from './FormActionEventArgs';
+/**
+ * @internal
+ */
+export interface IFormCustomizerAdditionalInitParameters extends _IAdditionalInitParameters {
+    displayMode: FormDisplayMode;
+}
+/**
+ * This is the base class that third parties should extend when implementing
+ * a client-side extension that provides a custom list form (display, new, edit) for a SharePoint list.
+ * @public
+ */
+declare abstract class BaseFormCustomizer<TProperties> extends BaseExtension<TProperties> {
+    /**
+     * SPEvent name when the form action should be performed.
+     *
+     * @internal
+     */
+    static _formActionEventName: string;
+    /**
+     * {@inheritDoc @microsoft/sp-extension-base#BaseExtension.context}
+     */
+    readonly context: FormCustomizerContext;
+    private readonly _formActionEvent;
+    private _displayMode;
+    /**
+     * This property is a pointer to the root DOM element of the form. This is a DIV element and contains the whole
+     * DOM subtree of the form.
+     *
+     * @readonly
+     */
+    protected get domElement(): HTMLElement;
+    /**
+     * Display mode of the form: Edit, Display or New.
+     *
+     * @readonly
+     */
+    protected get displayMode(): FormDisplayMode;
+    /**
+     * Event that gets raised every time the selected items in the list view change.
+     * Reserved for the future.
+     *
+     * @eventproperty
+     * @internal
+     */
+    get formActionEvent(): SPEvent<FormActionEventArgs>;
+    /**
+     * @internal
+     */
+    _init(context: ExtensionContext, propertiesJson: string | undefined, additionalInitParameters: IFormCustomizerAdditionalInitParameters | undefined): Promise<void>;
+    /**
+     * @internal
+     */
+    _internalRender(): void;
+    /**
+     * Internal API to set form's display mode.
+     * @internal
+     */
+    _internalSetDisplayMode(newDisplayMode: FormDisplayMode): void;
+    /**
+     * Use this method to initiate saving of the form.
+     *
+     * @internal
+     */
+    _save(): void;
+    /**
+     * Use this method to initiate closing/cancelling of the form.
+     *
+     * @internal
+     */
+    _close(): void;
+    /**
+     * Disposes the component.
+     *
+     * @remarks
+     * Please, do not override this method.
+     * Override the `onDispose` method instead.
+     */
+    dispose(): void;
+    /**
+     * @internal
+     */
+    protected _initializeExtensionType(): void;
+    /**
+     * This API is called to render the form. There is no base implementation of this API and the form is
+     * required to override this API.
+     */
+    protected abstract render(): void;
+    /**
+     * Call this method after the form has been saved to inform the application that the form has been saved.
+     */
+    protected formSaved(): void;
+    /**
+     * Call this method after the form has been closed/cancelled to inform the application that the form has been closed.
+     */
+    protected formClosed(): void;
+}
+export default BaseFormCustomizer;
+//# sourceMappingURL=BaseFormCustomizer.d.ts.map

package/lib/formCustomizer/BaseFormCustomizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseFormCustomizer.d.ts","sourceRoot":"","sources":["../../src/formCustomizer/BaseFormCustomizer.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,KAAK,gBAAgB,EACrB,KAAK,0BAA0B,EAChC,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,KAAK,eAAe,EAAE,OAAO,EAAmB,MAAM,4BAA4B,CAAC;AAC5F,OAAO,KAAK,qBAAqB,MAAM,yBAAyB,CAAC;AACjE,OAAO,EAAc,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAExE;;GAEG;AACH,MAAM,WAAW,uCAAwC,SAAQ,0BAA0B;IACzF,WAAW,EAAE,eAAe,CAAC;CAC9B;AAED;;;;GAIG;AACH,uBAAe,kBAAkB,CAAC,WAAW,CAAE,SAAQ,aAAa,CAAC,WAAW,CAAC;IAC/E;;;;OAIG;IACH,OAAc,oBAAoB,EAAE,MAAM,CAA+B;IAEzE;;OAEG;IAEH,SAAgB,OAAO,EAAG,qBAAqB,CAAC;IAEhD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAE/B;IACF,OAAO,CAAC,YAAY,CAAmB;IAGvC;;;;;OAKG;IACH,SAAS,KAAK,UAAU,IAAI,WAAW,CAEtC;IAED;;;;OAIG;IACH,SAAS,KAAK,WAAW,IAAI,eAAe,CAE3C;IAED;;;;;;OAMG;IACH,IAAW,eAAe,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAEzD;IAED;;OAEG;IACI,KAAK,CACV,OAAO,EAAE,gBAAgB,EACzB,cAAc,EAAE,MAAM,GAAG,SAAS,EAClC,wBAAwB,EAAE,uCAAuC,GAAG,SAAS,GAC5E,OAAO,CAAC,IAAI,CAAC;IAOhB;;OAEG;IACI,eAAe,IAAI,IAAI;IAI9B;;;OAGG;IACI,uBAAuB,CAAC,cAAc,EAAE,eAAe,GAAG,IAAI;IAIrE;;;;OAIG;IACI,KAAK,IAAI,IAAI;IAOpB;;;;OAIG;IACI,MAAM,IAAI,IAAI;IAOrB;;;;;;OAMG;IACI,OAAO,IAAI,IAAI;IAKtB;;OAEG;IACH,SAAS,CAAC,wBAAwB,IAAI,IAAI;IAK1C;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,MAAM,IAAI,IAAI;IAEjC;;OAEG;IACH,SAAS,CAAC,SAAS,IAAI,IAAI;IAI3B;;OAEG;IACH,SAAS,CAAC,UAAU,IAAI,IAAI;CAG7B;AAED,eAAe,kBAAkB,CAAC"}