@pnp/sp 4.0.0-alpha0-v4nightly.20240108 → 4.0.0-alpha0-v4nightly.20240110

package/commonjs/features/types.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Feature = exports._Feature = exports.Features = exports._Features = void 0;
+const tslib_1 = require("tslib");
+const queryable_1 = require("@pnp/queryable");
+const spqueryable_js_1 = require("../spqueryable.js");
+const decorators_js_1 = require("../decorators.js");
+let _Features = class _Features extends spqueryable_js_1._SPCollection {
+    /**
+     * Adds (activates) the specified feature
+     *
+     * @param id The Id of the feature (GUID)
+     * @param force If true the feature activation will be forced
+     */
+    async add(featureId, force = false) {
+        const data = await (0, spqueryable_js_1.spPost)((0, exports.Features)(this, "add"), (0, queryable_1.body)({
+            featdefScope: 0,
+            featureId,
+            force,
+        }));
+        return {
+            data: data,
+            feature: this.getById(featureId),
+        };
+    }
+    /**
+     * Gets a feature from the collection with the specified guid
+     *
+     * @param id The Id of the feature (GUID)
+     */
+    getById(id) {
+        return (0, exports.Feature)(this).concat(`('${id}')`);
+    }
+    /**
+     * Removes (deactivates) a feature from the collection
+     *
+     * @param id The Id of the feature (GUID)
+     * @param force If true the feature deactivation will be forced
+     */
+    remove(featureId, force = false) {
+        return (0, spqueryable_js_1.spPost)((0, exports.Features)(this, "remove"), (0, queryable_1.body)({
+            featureId,
+            force,
+        }));
+    }
+};
+_Features = (0, tslib_1.__decorate)([
+    (0, decorators_js_1.defaultPath)("features")
+], _Features);
+exports._Features = _Features;
+exports.Features = (0, spqueryable_js_1.spInvokableFactory)(_Features);
+class _Feature extends spqueryable_js_1._SPInstance {
+}
+exports._Feature = _Feature;
+exports.Feature = (0, spqueryable_js_1.spInvokableFactory)(_Feature);
+//# sourceMappingURL=types.js.map

package/commonjs/features/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../packages/sp/features/types.ts"],"names":[],"mappings":";;;;AAAA,8CAAsC;AACtC,sDAK2B;AAC3B,oDAA+C;AAG/C,IAAa,SAAS,GAAtB,MAAa,SAAU,SAAQ,8BAA6B;IAExD;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CAAC,SAAiB,EAAE,KAAK,GAAG,KAAK;QAE7C,MAAM,IAAI,GAAG,MAAM,IAAA,uBAAM,EAAC,IAAA,gBAAQ,EAAC,IAAI,EAAE,KAAK,CAAC,EAAE,IAAA,gBAAI,EAAC;YAClD,YAAY,EAAE,CAAC;YACf,SAAS;YACT,KAAK;SACR,CAAC,CAAC,CAAC;QAEJ,OAAO;YACH,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;SACnC,CAAC;IACN,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,EAAU;QACrB,OAAO,IAAA,eAAO,EAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,SAAiB,EAAE,KAAK,GAAG,KAAK;QAE1C,OAAO,IAAA,uBAAM,EAAC,IAAA,gBAAQ,EAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,IAAA,gBAAI,EAAC;YACzC,SAAS;YACT,KAAK;SACR,CAAC,CAAC,CAAC;IACR,CAAC;CACJ,CAAA;AA5CY,SAAS;IADrB,IAAA,2BAAW,EAAC,UAAU,CAAC;GACX,SAAS,CA4CrB;AA5CY,8BAAS;AA8CT,QAAA,QAAQ,GAAG,IAAA,mCAAkB,EAAY,SAAS,CAAC,CAAC;AAEjE,MAAa,QAAS,SAAQ,4BAAyB;CAAI;AAA3D,4BAA2D;AAE9C,QAAA,OAAO,GAAG,IAAA,mCAAkB,EAAW,QAAQ,CAAC,CAAC"}

package/commonjs/features/web.d.ts

@@ -0,0 +1,13 @@
+import { IFeatures } from "./types.js";
+declare module "../webs/types" {
+    interface _Web {
+        readonly features: IFeatures;
+    }
+    interface IWeb {
+        /**
+         * Access the features activated in this web
+         */
+        readonly features: IFeatures;
+    }
+}
+//# sourceMappingURL=web.d.ts.map

package/commonjs/features/web.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/features/web.ts"],"names":[],"mappings":"AAEA,OAAO,EAAY,SAAS,EAAE,MAAM,YAAY,CAAC;AAEjD,OAAO,QAAQ,eAAe,CAAC;IAC3B,UAAU,IAAI;QACV,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;KAChC;IACD,UAAU,IAAI;QACV;;WAEG;QACH,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;KAChC;CACJ"}

package/commonjs/features/web.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const queryable_1 = require("@pnp/queryable");
+const types_js_1 = require("../webs/types.js");
+const types_js_2 = require("./types.js");
+(0, queryable_1.addProp)(types_js_1._Web, "features", types_js_2.Features);
+//# sourceMappingURL=web.js.map

package/commonjs/features/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../../../../packages/sp/features/web.ts"],"names":[],"mappings":";;AAAA,8CAAyC;AACzC,+CAAwC;AACxC,yCAAiD;AAcjD,IAAA,mBAAO,EAAC,eAAI,EAAE,UAAU,EAAE,mBAAQ,CAAC,CAAC"}

package/commonjs/fi.d.ts

@@ -0,0 +1,25 @@
+import { TimelinePipe } from "@pnp/core";
+import { ISPQueryable, SPInit } from "./spqueryable.js";
+export declare class SPFI {
+    protected _root: ISPQueryable;
+    /**
+     * Creates a new instance of the SPFI class
+     *
+     * @param root Establishes a root url/configuration
+     */
+    constructor(root?: SPInit);
+    /**
+     * Applies one or more behaviors which will be inherited by all instances chained from this root
+     *
+     */
+    using(...behaviors: TimelinePipe[]): this;
+    /**
+     * Used by extending classes to create new objects directly from the root
+     *
+     * @param factory The factory for the type of object to create
+     * @returns A configured instance of that object
+     */
+    protected create<T extends ISPQueryable>(factory: (q: ISPQueryable, path?: string) => T, path?: string): T;
+}
+export declare function spfi(root?: SPInit | SPFI): SPFI;
+//# sourceMappingURL=fi.d.ts.map

package/commonjs/fi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fi.d.ts","sourceRoot":"","sources":["../../../../packages/sp/fi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,YAAY,EAAe,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAErE,qBAAa,IAAI;IAEb,SAAS,CAAC,KAAK,EAAE,YAAY,CAAC;IAE9B;;;;OAIG;gBACS,IAAI,GAAE,MAAW;IAK7B;;;OAGG;IACI,KAAK,CAAC,GAAG,SAAS,EAAE,YAAY,EAAE,GAAG,IAAI;IAMhD;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,CAAC,SAAS,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,YAAY,EAAE,IAAI,CAAC,EAAE,MAAM,KAAK,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,CAAC;CAG7G;AAED,wBAAgB,IAAI,CAAC,IAAI,GAAE,MAAM,GAAG,IAAS,GAAG,IAAI,CAOnD"}

package/commonjs/fi.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.spfi = exports.SPFI = void 0;
+const spqueryable_js_1 = require("./spqueryable.js");
+class SPFI {
+    /**
+     * Creates a new instance of the SPFI class
+     *
+     * @param root Establishes a root url/configuration
+     */
+    constructor(root = "") {
+        this._root = (0, spqueryable_js_1.SPQueryable)(root);
+    }
+    /**
+     * Applies one or more behaviors which will be inherited by all instances chained from this root
+     *
+     */
+    using(...behaviors) {
+        this._root.using(...behaviors);
+        return this;
+    }
+    /**
+     * Used by extending classes to create new objects directly from the root
+     *
+     * @param factory The factory for the type of object to create
+     * @returns A configured instance of that object
+     */
+    create(factory, path) {
+        return factory(this._root, path);
+    }
+}
+exports.SPFI = SPFI;
+function spfi(root = "") {
+    if (typeof root === "object" && !Reflect.has(root, "length")) {
+        root = root._root;
+    }
+    return new SPFI(root);
+}
+exports.spfi = spfi;
+//# sourceMappingURL=fi.js.map

package/commonjs/fi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fi.js","sourceRoot":"","sources":["../../../../packages/sp/fi.ts"],"names":[],"mappings":";;;AACA,qDAAqE;AAErE,MAAa,IAAI;IAIb;;;;OAIG;IACH,YAAY,OAAe,EAAE;QAEzB,IAAI,CAAC,KAAK,GAAG,IAAA,4BAAW,EAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,GAAG,SAAyB;QAErC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,CAAC;QAC/B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACO,MAAM,CAAyB,OAA8C,EAAE,IAAa;QAClG,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC;CACJ;AAjCD,oBAiCC;AAED,SAAgB,IAAI,CAAC,OAAsB,EAAE;IAEzC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE;QAC1D,IAAI,GAAS,IAAK,CAAC,KAAK,CAAC;KAC5B;IAED,OAAO,IAAI,IAAI,CAAM,IAAI,CAAC,CAAC;AAC/B,CAAC;AAPD,oBAOC"}

package/commonjs/fields/index.d.ts

@@ -0,0 +1,4 @@
+import "./web.js";
+import "./list.js";
+export { IFields, Fields, IField, Field, IFieldAddResult, IFieldUpdateResult, AddFieldOptions, CalendarType, ChoiceFieldFormatType, DateTimeFieldFormatType, DateTimeFieldFriendlyFormatType, FieldTypes, FieldUserSelectionMode, IFieldCreationProperties, UrlFieldFormatType, IXmlSchemaFieldCreationInformation, IFieldInfo, } from "./types.js";
+//# sourceMappingURL=index.d.ts.map

package/commonjs/fields/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/fields/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,CAAC;AAClB,OAAO,WAAW,CAAC;AAEnB,OAAO,EACH,OAAO,EACP,MAAM,EACN,MAAM,EACN,KAAK,EACL,eAAe,EACf,kBAAkB,EAClB,eAAe,EACf,YAAY,EACZ,qBAAqB,EACrB,uBAAuB,EACvB,+BAA+B,EAC/B,UAAU,EACV,sBAAsB,EACtB,wBAAwB,EACxB,kBAAkB,EAClB,kCAAkC,EAClC,UAAU,GACb,MAAM,YAAY,CAAC"}

package/commonjs/fields/index.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UrlFieldFormatType = exports.FieldUserSelectionMode = exports.FieldTypes = exports.DateTimeFieldFriendlyFormatType = exports.DateTimeFieldFormatType = exports.ChoiceFieldFormatType = exports.CalendarType = exports.AddFieldOptions = exports.Field = exports.Fields = void 0;
+require("./web.js");
+require("./list.js");
+var types_js_1 = require("./types.js");
+Object.defineProperty(exports, "Fields", { enumerable: true, get: function () { return types_js_1.Fields; } });
+Object.defineProperty(exports, "Field", { enumerable: true, get: function () { return types_js_1.Field; } });
+Object.defineProperty(exports, "AddFieldOptions", { enumerable: true, get: function () { return types_js_1.AddFieldOptions; } });
+Object.defineProperty(exports, "CalendarType", { enumerable: true, get: function () { return types_js_1.CalendarType; } });
+Object.defineProperty(exports, "ChoiceFieldFormatType", { enumerable: true, get: function () { return types_js_1.ChoiceFieldFormatType; } });
+Object.defineProperty(exports, "DateTimeFieldFormatType", { enumerable: true, get: function () { return types_js_1.DateTimeFieldFormatType; } });
+Object.defineProperty(exports, "DateTimeFieldFriendlyFormatType", { enumerable: true, get: function () { return types_js_1.DateTimeFieldFriendlyFormatType; } });
+Object.defineProperty(exports, "FieldTypes", { enumerable: true, get: function () { return types_js_1.FieldTypes; } });
+Object.defineProperty(exports, "FieldUserSelectionMode", { enumerable: true, get: function () { return types_js_1.FieldUserSelectionMode; } });
+Object.defineProperty(exports, "UrlFieldFormatType", { enumerable: true, get: function () { return types_js_1.UrlFieldFormatType; } });
+//# sourceMappingURL=index.js.map

package/commonjs/fields/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/sp/fields/index.ts"],"names":[],"mappings":";;;AAAA,oBAAkB;AAClB,qBAAmB;AAEnB,uCAkBoB;AAhBhB,kGAAA,MAAM,OAAA;AAEN,iGAAA,KAAK,OAAA;AAGL,2GAAA,eAAe,OAAA;AACf,wGAAA,YAAY,OAAA;AACZ,iHAAA,qBAAqB,OAAA;AACrB,mHAAA,uBAAuB,OAAA;AACvB,2HAAA,+BAA+B,OAAA;AAC/B,sGAAA,UAAU,OAAA;AACV,kHAAA,sBAAsB,OAAA;AAEtB,8GAAA,kBAAkB,OAAA"}

package/commonjs/fields/list.d.ts

@@ -0,0 +1,13 @@
+import { IFields } from "./types.js";
+declare module "../lists/types" {
+    interface _List {
+        readonly fields: IFields;
+    }
+    interface IList {
+        /**
+         * This list's collection of fields
+         */
+        readonly fields: IFields;
+    }
+}
+//# sourceMappingURL=list.d.ts.map

package/commonjs/fields/list.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/fields/list.ts"],"names":[],"mappings":"AAEA,OAAO,EAAU,OAAO,EAAE,MAAM,YAAY,CAAC;AAE7C,OAAO,QAAQ,gBAAgB,CAAC;IAC5B,UAAU,KAAK;QACX,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;KAC5B;IACD,UAAU,KAAK;QACf;;WAEG;QACC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;KAC5B;CACJ"}

package/commonjs/fields/list.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const queryable_1 = require("@pnp/queryable");
+const types_js_1 = require("../lists/types.js");
+const types_js_2 = require("./types.js");
+(0, queryable_1.addProp)(types_js_1._List, "fields", types_js_2.Fields);
+//# sourceMappingURL=list.js.map

package/commonjs/fields/list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.js","sourceRoot":"","sources":["../../../../../packages/sp/fields/list.ts"],"names":[],"mappings":";;AAAA,8CAAyC;AACzC,gDAA0C;AAC1C,yCAA6C;AAc7C,IAAA,mBAAO,EAAC,gBAAK,EAAE,QAAQ,EAAE,iBAAM,CAAC,CAAC"}

package/commonjs/fields/types.d.ts

@@ -0,0 +1,402 @@
+import { _SPCollection, _SPInstance, IDeleteable } from "../spqueryable.js";
+export declare class _Fields extends _SPCollection<IFieldInfo[]> {
+    /**
+     * Creates a field based on the specified schema
+     *
+     * @param xml A string or XmlSchemaFieldCreationInformation instance descrbing the field to create
+     */
+    createFieldAsXml(xml: string | IXmlSchemaFieldCreationInformation): Promise<IFieldAddResult>;
+    /**
+     * Gets a field from the collection by id
+     *
+     * @param id The Id of the list
+     */
+    getById(id: string): IField;
+    /**
+     * Gets a field from the collection by title
+     *
+     * @param title The case-sensitive title of the field
+     */
+    getByTitle(title: string): IField;
+    /**
+     * Gets a field from the collection by using internal name or title
+     *
+     * @param name The case-sensitive internal name or title of the field
+     */
+    getByInternalNameOrTitle(name: string): IField;
+    /**
+     * Adds a new field to the collection
+     *
+     * @param title The new field's title
+     * @param properties Differ by type of field being created (see: https://msdn.microsoft.com/en-us/library/office/dn600182.aspx)
+     */
+    add(title: string, fieldTypeKind: number, properties?: IFieldCreationProperties): Promise<IFieldAddResult>;
+    /**
+     * Adds a new field to the collection
+     *
+     * @param title The new field's title
+     * @param properties Differ by type of field being created (see: https://msdn.microsoft.com/en-us/library/office/dn600182.aspx)
+     */
+    addField(title: string, fieldTypeKind: number, properties?: IAddFieldProperties): Promise<IFieldAddResult>;
+    /**
+     * Adds a new SP.FieldText to the collection
+     *
+     * @param title The field title
+     * @param properties Differ by type of field being created (see: https://msdn.microsoft.com/en-us/library/office/dn600182.aspx)
+     */
+    addText(title: string, properties?: IFieldCreationProperties & AddTextProps): Promise<IFieldAddResult>;
+    /**
+     * Adds a new SP.FieldCalculated to the collection
+     *
+     * @param title The field title.
+     * @param properties Differ by type of field being created (see: https://msdn.microsoft.com/en-us/library/office/dn600182.aspx)
+     */
+    addCalculated(title: string, properties?: IFieldCreationProperties & AddCalculatedProps): Promise<IFieldAddResult>;
+    /**
+     * Adds a new SP.FieldDateTime to the collection
+     *
+     * @param title The field title
+     * @param properties Differ by type of field being created (see: https://msdn.microsoft.com/en-us/library/office/dn600182.aspx)
+     */
+    addDateTime(title: string, properties?: IFieldCreationProperties & AddDateTimeProps): Promise<IFieldAddResult>;
+    /**
+     * Adds a new SP.FieldNumber to the collection
+     *
+     * @param title The field title
+     * @param properties Differ by type of field being created (see: https://msdn.microsoft.com/en-us/library/office/dn600182.aspx)
+     */
+    addNumber(title: string, properties?: IFieldCreationProperties & AddNumberProps): Promise<IFieldAddResult>;
+    /**
+     * Adds a new SP.FieldCurrency to the collection
+     *
+     * @param title The field title
+     * @param properties Differ by type of field being created (see: https://msdn.microsoft.com/en-us/library/office/dn600182.aspx)
+     */
+    addCurrency(title: string, properties?: IFieldCreationProperties & AddCurrencyProps): Promise<IFieldAddResult>;
+    /**
+     * Adds a new SP.FieldMultiLineText to the collection
+     *
+     * @param title The field title
+     * @param properties Differ by type of field being created (see: https://msdn.microsoft.com/en-us/library/office/dn600182.aspx)
+     *
+     */
+    addMultilineText(title: string, properties?: IFieldCreationProperties & AddMultilineTextProps): Promise<IFieldAddResult>;
+    /**
+     * Adds a new SP.FieldUrl to the collection
+     *
+     * @param title The field title
+     */
+    addUrl(title: string, properties?: IFieldCreationProperties & AddUrlProps): Promise<IFieldAddResult>;
+    /** Adds a user field to the colleciton
+     *
+     * @param title The new field's title
+     * @param properties
+     */
+    addUser(title: string, properties?: IFieldCreationProperties & AddUserProps): Promise<IFieldAddResult>;
+    /**
+     * Adds a SP.FieldLookup to the collection
+     *
+     * @param title The new field's title
+     * @param properties Set of additional properties to set on the new field
+     */
+    addLookup(title: string, properties?: IAddFieldProperties): Promise<IFieldAddResult>;
+    /**
+     * Adds a new SP.FieldChoice to the collection
+     *
+     * @param title The field title.
+     * @param properties Differ by type of field being created (see: https://msdn.microsoft.com/en-us/library/office/dn600182.aspx)
+     */
+    addChoice(title: string, properties?: IFieldCreationProperties & AddChoiceProps): Promise<IFieldAddResult>;
+    /**
+     * Adds a new SP.FieldMultiChoice to the collection
+     *
+     * @param title The field title.
+     * @param properties Differ by type of field being created (see: https://msdn.microsoft.com/en-us/library/office/dn600182.aspx)
+     */
+    addMultiChoice(title: string, properties?: IFieldCreationProperties & AddMultiChoiceProps): Promise<IFieldAddResult>;
+    /**
+   * Adds a new SP.FieldBoolean to the collection
+   *
+   * @param title The field title.
+   * @param properties Differ by type of field being created (see: https://msdn.microsoft.com/en-us/library/office/dn600182.aspx)
+   */
+    addBoolean(title: string, properties?: IFieldCreationProperties): Promise<IFieldAddResult>;
+    /**
+  * Creates a secondary (dependent) lookup field, based on the Id of the primary lookup field.
+  *
+  * @param displayName The display name of the new field.
+  * @param primaryLookupFieldId The guid of the primary Lookup Field.
+  * @param showField Which field to show from the lookup list.
+  */
+    addDependentLookupField(displayName: string, primaryLookupFieldId: string, showField: string): Promise<IFieldAddResult>;
+    /**
+   * Adds a new SP.FieldLocation to the collection
+   *
+   * @param title The field title.
+   * @param properties Differ by type of field being created (see: https://msdn.microsoft.com/en-us/library/office/dn600182.aspx)
+   */
+    addLocation(title: string, properties?: IFieldCreationProperties): Promise<IFieldAddResult>;
+    /**
+     * Adds a new SP.FieldLocation to the collection
+     *
+     * @param title The field title.
+     * @param properties Differ by type of field being created (see: https://msdn.microsoft.com/en-us/library/office/dn600182.aspx)
+     */
+    addImageField(title: string, properties?: IFieldCreationProperties): Promise<IFieldAddResult>;
+}
+export interface IFields extends _Fields {
+}
+export declare const Fields: import("../spqueryable.js").ISPInvokableFactory<IFields>;
+export declare class _Field extends _SPInstance<IFieldInfo> {
+    delete: (this: import("../spqueryable.js").ISPQueryable<any>) => Promise<void>;
+    /**
+   * Updates this field instance with the supplied properties
+   *
+   * @param properties A plain object hash of values to update for the list
+   * @param fieldType The type value such as SP.FieldLookup. Optional, looked up from the field if not provided
+   */
+    update(properties: any, fieldType?: string): Promise<IFieldUpdateResult>;
+    /**
+   * Sets the value of the ShowInDisplayForm property for this field.
+   */
+    setShowInDisplayForm(show: boolean): Promise<void>;
+    /**
+   * Sets the value of the ShowInEditForm property for this field.
+   */
+    setShowInEditForm(show: boolean): Promise<void>;
+    /**
+   * Sets the value of the ShowInNewForm property for this field.
+   */
+    setShowInNewForm(show: boolean): Promise<void>;
+}
+export interface IField extends _Field, IDeleteable {
+}
+export declare const Field: import("../spqueryable.js").ISPInvokableFactory<IField>;
+/**
+ * This interface defines the result of adding a field
+ */
+export interface IFieldAddResult {
+    data: Partial<IFieldInfo>;
+    field: IField;
+}
+/**
+ * This interface defines the result of updating a field
+ */
+export interface IFieldUpdateResult {
+    data: Partial<IFieldInfo>;
+    field: IField;
+}
+export declare type AddTextProps = {
+    MaxLength?: number;
+};
+export declare type AddCalculatedProps = {
+    DateFormat?: DateTimeFieldFormatType;
+    FieldTypeKind?: number;
+    Formula?: string;
+    OutputType?: FieldTypes;
+};
+export declare type AddDateTimeProps = {
+    DateTimeCalendarType?: CalendarType;
+    DisplayFormat?: DateTimeFieldFormatType;
+    FriendlyDisplayFormat?: DateTimeFieldFriendlyFormatType;
+};
+export declare type AddNumberProps = {
+    MinimumValue?: number;
+    MaximumValue?: number;
+};
+export declare type AddCurrencyProps = AddNumberProps & {
+    CurrencyLocaleId?: number;
+};
+export declare type AddMultilineTextProps = {
+    AllowHyperlink?: boolean;
+    AppendOnly?: boolean;
+    NumberOfLines?: number;
+    RestrictedMode?: boolean;
+    RichText?: boolean;
+};
+export declare type AddUrlProps = {
+    DisplayFormat?: UrlFieldFormatType;
+};
+export declare type AddUserProps = {
+    SelectionMode?: FieldUserSelectionMode;
+};
+export declare type AddChoiceProps = {
+    Choices: string[];
+    EditFormat?: ChoiceFieldFormatType;
+    FillInChoice?: boolean;
+};
+export declare type AddMultiChoiceProps = {
+    Choices: string[];
+    FillInChoice?: boolean;
+};
+/**
+ * Specifies the type of the field.
+ */
+export declare const enum FieldTypes {
+    Invalid = 0,
+    Integer = 1,
+    Text = 2,
+    Note = 3,
+    DateTime = 4,
+    Counter = 5,
+    Choice = 6,
+    Lookup = 7,
+    Boolean = 8,
+    Number = 9,
+    Currency = 10,
+    URL = 11,
+    Computed = 12,
+    Threading = 13,
+    Guid = 14,
+    MultiChoice = 15,
+    GridChoice = 16,
+    Calculated = 17,
+    File = 18,
+    Attachments = 19,
+    User = 20,
+    Recurrence = 21,
+    CrossProjectLink = 22,
+    ModStat = 23,
+    Error = 24,
+    ContentTypeId = 25,
+    PageSeparator = 26,
+    ThreadIndex = 27,
+    WorkflowStatus = 28,
+    AllDayEvent = 29,
+    WorkflowEventType = 30,
+    Location = 33,
+    Image = 34
+}
+export declare enum DateTimeFieldFormatType {
+    DateOnly = 0,
+    DateTime = 1
+}
+export declare enum DateTimeFieldFriendlyFormatType {
+    Unspecified = 0,
+    Disabled = 1,
+    Relative = 2
+}
+/**
+ * Specifies the control settings while adding a field.
+ */
+export declare const enum AddFieldOptions {
+    /**
+   *  Specify that a new field added to the list must also be added to the default content type in the site collection
+   */
+    DefaultValue = 0,
+    /**
+   * Specify that a new field added to the list must also be added to the default content type in the site collection.
+   */
+    AddToDefaultContentType = 1,
+    /**
+   * Specify that a new field must not be added to any other content type
+   */
+    AddToNoContentType = 2,
+    /**
+   *  Specify that a new field that is added to the specified list must also be added to all content types in the site collection
+   */
+    AddToAllContentTypes = 4,
+    /**
+   * Specify adding an internal field name hint for the purpose of avoiding possible database locking or field renaming operations
+   */
+    AddFieldInternalNameHint = 8,
+    /**
+   * Specify that a new field that is added to the specified list must also be added to the default list view
+   */
+    AddFieldToDefaultView = 16,
+    /**
+   * Specify to confirm that no other field has the same display name
+   */
+    AddFieldCheckDisplayName = 32
+}
+export interface IXmlSchemaFieldCreationInformation {
+    Options?: AddFieldOptions;
+    SchemaXml: string;
+}
+export declare const enum CalendarType {
+    Gregorian = 1,
+    Japan = 3,
+    Taiwan = 4,
+    Korea = 5,
+    Hijri = 6,
+    Thai = 7,
+    Hebrew = 8,
+    GregorianMEFrench = 9,
+    GregorianArabic = 10,
+    GregorianXLITEnglish = 11,
+    GregorianXLITFrench = 12,
+    KoreaJapanLunar = 14,
+    ChineseLunar = 15,
+    SakaEra = 16,
+    UmAlQura = 23
+}
+export declare enum UrlFieldFormatType {
+    Hyperlink = 0,
+    Image = 1
+}
+export declare enum FieldUserSelectionMode {
+    PeopleAndGroups = 1,
+    PeopleOnly = 0
+}
+export interface IFieldCreationProperties {
+    DefaultFormula?: string;
+    Description?: string;
+    EnforceUniqueValues?: boolean;
+    FieldTypeKind?: number;
+    Group?: string;
+    Hidden?: boolean;
+    Indexed?: boolean;
+    Required?: boolean;
+    Title?: string;
+    ValidationFormula?: string;
+    ValidationMessage?: string;
+}
+export interface IAddFieldProperties {
+    Title?: string;
+    Type?: number;
+    Required?: boolean;
+    IsCompactName?: boolean;
+    LookupListId?: string;
+    LookupWebId?: string;
+    Choices?: string[];
+    LookupFieldName?: string;
+}
+export declare enum ChoiceFieldFormatType {
+    Dropdown = 0,
+    RadioButtons = 1
+}
+export interface IFieldInfo {
+    Choices?: string[];
+    DefaultFormula: string | null;
+    DefaultValue: string | null;
+    Description: string;
+    Direction: string;
+    EnforceUniqueValues: boolean;
+    EntityPropertyName: string;
+    FieldTypeKind: FieldTypes;
+    Filterable: boolean;
+    FromBaseType: boolean;
+    Group: string;
+    Hidden: boolean;
+    Id: string;
+    Indexed: boolean;
+    IndexStatus: number;
+    InternalName: string;
+    JSLink: string;
+    PinnedToFiltersPane: boolean;
+    ReadOnlyField: boolean;
+    Required: boolean;
+    SchemaXml: string;
+    Scope: string;
+    Sealed: boolean;
+    ShowInFiltersPane: number;
+    Sortable: boolean;
+    StaticName: string;
+    Title: string;
+    TypeAsString: string;
+    TypeDisplayName: string;
+    TypeShortDescription: string;
+    ValidationFormula: string | null;
+    ValidationMessage: string | null;
+}
+//# sourceMappingURL=types.d.ts.map

package/commonjs/fields/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/fields/types.ts"],"names":[],"mappings":"AACA,OAAO,EACH,aAAa,EACb,WAAW,EAGX,WAAW,EAGd,MAAM,mBAAmB,CAAC;AAI3B,qBACa,OAAQ,SAAQ,aAAa,CAAC,UAAU,EAAE,CAAC;IAEpD;;;;OAIG;IACU,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,kCAAkC,GAAG,OAAO,CAAC,eAAe,CAAC;IAczG;;;;OAIG;IACI,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;IAIlC;;;;OAIG;IACI,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAIxC;;;;OAIG;IACI,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAIrD;;;;;OAKG;IACU,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,OAAO,CAAC,eAAe,CAAC;IAiBvH;;;;;OAKG;IACU,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,eAAe,CAAC;IAgBvH;;;;;OAKG;IACI,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,YAAY,GAAG,OAAO,CAAC,eAAe,CAAC;IAQ7G;;;;;OAKG;IACI,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC;IAQzH;;;;;OAKG;IACI,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;IAUrH;;;;;OAKG;IACI,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAKjH;;;;;OAKG;IACI,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;IAQrH;;;;;;OAMG;IACI,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,qBAAqB,GAAG,OAAO,CAAC,eAAe,CAAC;IAY/H;;;;OAIG;IACI,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,WAAW,GAAG,OAAO,CAAC,eAAe,CAAC;IAQ3G;;;;OAIG;IACI,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,YAAY,GAAG,OAAO,CAAC,eAAe,CAAC;IAQ7G;;;;;OAKG;IACU,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,eAAe,CAAC;IAKjG;;;;;OAKG;IACI,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAYjH;;;;;OAKG;IACI,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,mBAAmB,GAAG,OAAO,CAAC,eAAe,CAAC;IAY3H;;;;;KAKC;IACM,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,OAAO,CAAC,eAAe,CAAC;IAKjG;;;;;;IAMA;IACa,uBAAuB,CAAC,WAAW,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAYpI;;;;;KAKC;IACM,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,OAAO,CAAC,eAAe,CAAC;IAKlG;;;;;OAKG;IACI,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,OAAO,CAAC,eAAe,CAAC;CAIvG;AACD,MAAM,WAAW,OAAQ,SAAQ,OAAO;CAAI;AAC5C,eAAO,MAAM,MAAM,0DAAuC,CAAC;AAE3D,qBAAa,MAAO,SAAQ,WAAW,CAAC,UAAU,CAAC;IAExC,MAAM,yEAAgB;IAE7B;;;;;KAKC;IACY,MAAM,CAAC,UAAU,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAerF;;KAEC;IACM,oBAAoB,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzD;;KAEC;IACM,iBAAiB,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD;;KAEC;IACM,gBAAgB,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAGxD;AACD,MAAM,WAAW,MAAO,SAAQ,MAAM,EAAE,WAAW;CAAI;AACvD,eAAO,MAAM,KAAK,yDAAqC,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,oBAAY,YAAY,GAAG;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,oBAAY,kBAAkB,GAAG;IAC7B,UAAU,CAAC,EAAE,uBAAuB,CAAC;IACrC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,UAAU,CAAC;CAC3B,CAAC;AAEF,oBAAY,gBAAgB,GAAG;IAC3B,oBAAoB,CAAC,EAAE,YAAY,CAAC;IACpC,aAAa,CAAC,EAAE,uBAAuB,CAAC;IACxC,qBAAqB,CAAC,EAAE,+BAA+B,CAAC;CAC3D,CAAC;AAEF,oBAAY,cAAc,GAAG;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,oBAAY,gBAAgB,GAAG,cAAc,GAAG;IAC5C,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF,oBAAY,qBAAqB,GAAG;IAChC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,oBAAY,WAAW,GAAG;IACtB,aAAa,CAAC,EAAE,kBAAkB,CAAC;CACtC,CAAC;AAEF,oBAAY,YAAY,GAAG;IACvB,aAAa,CAAC,EAAE,sBAAsB,CAAC;CAC1C,CAAC;AAEF,oBAAY,cAAc,GAAG;IACzB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,CAAC,EAAE,qBAAqB,CAAC;IACnC,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,oBAAY,mBAAmB,GAAG;IAC9B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,0BAAkB,UAAU;IACxB,OAAO,IAAI;IACX,OAAO,IAAI;IACX,IAAI,IAAI;IACR,IAAI,IAAI;IACR,QAAQ,IAAI;IACZ,OAAO,IAAI;IACX,MAAM,IAAI;IACV,MAAM,IAAI;IACV,OAAO,IAAI;IACX,MAAM,IAAI;IACV,QAAQ,KAAK;IACb,GAAG,KAAK;IACR,QAAQ,KAAK;IACb,SAAS,KAAK;IACd,IAAI,KAAK;IACT,WAAW,KAAK;IAChB,UAAU,KAAK;IACf,UAAU,KAAK;IACf,IAAI,KAAK;IACT,WAAW,KAAK;IAChB,IAAI,KAAK;IACT,UAAU,KAAK;IACf,gBAAgB,KAAK;IACrB,OAAO,KAAK;IACZ,KAAK,KAAK;IACV,aAAa,KAAK;IAClB,aAAa,KAAK;IAClB,WAAW,KAAK;IAChB,cAAc,KAAK;IACnB,WAAW,KAAK;IAChB,iBAAiB,KAAK;IACtB,QAAQ,KAAK;IACb,KAAK,KAAK;CACb;AA6BD,oBAAY,uBAAuB;IAC/B,QAAQ,IAAI;IACZ,QAAQ,IAAI;CACf;AAED,oBAAY,+BAA+B;IACvC,WAAW,IAAI;IACf,QAAQ,IAAI;IACZ,QAAQ,IAAI;CACf;AAED;;GAEG;AACH,0BAAkB,eAAe;IAC7B;;KAEC;IACD,YAAY,IAAI;IAChB;;KAEC;IACD,uBAAuB,IAAI;IAC3B;;KAEC;IACD,kBAAkB,IAAI;IACtB;;KAEC;IACD,oBAAoB,IAAI;IACxB;;KAEC;IACD,wBAAwB,IAAI;IAC5B;;KAEC;IACD,qBAAqB,KAAK;IAC1B;;KAEC;IACD,wBAAwB,KAAK;CAChC;AAED,MAAM,WAAW,kCAAkC;IAC/C,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,0BAAkB,YAAY;IAC1B,SAAS,IAAI;IACb,KAAK,IAAI;IACT,MAAM,IAAI;IACV,KAAK,IAAI;IACT,KAAK,IAAI;IACT,IAAI,IAAI;IACR,MAAM,IAAI;IACV,iBAAiB,IAAI;IACrB,eAAe,KAAK;IACpB,oBAAoB,KAAK;IACzB,mBAAmB,KAAK;IACxB,eAAe,KAAK;IACpB,YAAY,KAAK;IACjB,OAAO,KAAK;IACZ,QAAQ,KAAK;CAChB;AAED,oBAAY,kBAAkB;IAC1B,SAAS,IAAI;IACb,KAAK,IAAI;CACZ;AAED,oBAAY,sBAAsB;IAC9B,eAAe,IAAI;IACnB,UAAU,IAAI;CACjB;AAED,MAAM,WAAW,wBAAwB;IACrC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,mBAAmB;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,oBAAY,qBAAqB;IAC7B,QAAQ,IAAA;IACR,YAAY,IAAA;CACf;AAED,MAAM,WAAW,UAAU;IACvB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,aAAa,EAAE,UAAU,CAAC;IAC1B,UAAU,EAAE,OAAO,CAAC;IACpB,YAAY,EAAE,OAAO,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB,EAAE,OAAO,CAAC;IAC7B,aAAa,EAAE,OAAO,CAAC;IACvB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC"}