@pnp/sp 3.21.0-v3nightly.20240111 → 3.21.0-v4nightly.20240115

package/commonjs/hubsites/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/sp/hubsites/index.ts"],"names":[],"mappings":";;;AAAA,oCAAgC;AAChC,yCAAiD;AAEjD,qBAAmB;AACnB,oBAAkB;AAElB,uCAOoB;AANhB,mGAAA,OAAO,OAAA;AACP,oGAAA,QAAQ,OAAA;AAgBZ,OAAO,CAAC,cAAc,CAAC,YAAI,CAAC,SAAS,EAAE,UAAU,EAAE;IAC/C,YAAY,EAAE,IAAI;IAClB,UAAU,EAAE,IAAI;IAChB,GAAG,EAAE;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,mBAAQ,CAAC,CAAC;IACjC,CAAC;CACJ,CAAC,CAAC"}

package/commonjs/hubsites/site.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"site.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/hubsites/site.ts"],"names":[],"mappings":"AAGA,OAAO,QAAQ,gBAAgB,CAAC;IAC5B,UAAU,KAAK;QACX,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAC3C,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;QACjC,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;KACtC;IACD,UAAU,KAAK;QAEX;;;;;;WAMG;QACH,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAE3C;;WAEG;QACH,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;QAEjC;;WAEG;QACH,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;KACtC;CACJ"}

package/commonjs/hubsites/site.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const types_js_1 = require("../sites/types.js");
+const spqueryable_js_1 = require("../spqueryable.js");
+types_js_1._Site.prototype.joinHubSite = async function (siteId) {
+    await (0, spqueryable_js_1.spPost)((0, types_js_1.Site)(this, `joinHubSite('${siteId}')`));
+};
+types_js_1._Site.prototype.registerHubSite = async function () {
+    await (0, spqueryable_js_1.spPost)((0, types_js_1.Site)(this, "registerHubSite"));
+};
+types_js_1._Site.prototype.unRegisterHubSite = async function () {
+    await (0, spqueryable_js_1.spPost)((0, types_js_1.Site)(this, "unRegisterHubSite"));
+};
+//# sourceMappingURL=site.js.map

package/commonjs/hubsites/site.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"site.js","sourceRoot":"","sources":["../../../../../packages/sp/hubsites/site.ts"],"names":[],"mappings":";;AAAA,gDAAgD;AAChD,sDAA2C;AA+B3C,gBAAK,CAAC,SAAS,CAAC,WAAW,GAAG,KAAK,WAAwB,MAAc;IACrE,MAAM,IAAA,uBAAM,EAAC,IAAA,eAAI,EAAC,IAAI,EAAE,gBAAgB,MAAM,IAAI,CAAC,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF,gBAAK,CAAC,SAAS,CAAC,eAAe,GAAG,KAAK;IACnC,MAAM,IAAA,uBAAM,EAAC,IAAA,eAAI,EAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF,gBAAK,CAAC,SAAS,CAAC,iBAAiB,GAAG,KAAK;IACrC,MAAM,IAAA,uBAAM,EAAC,IAAA,eAAI,EAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC,CAAC;AAClD,CAAC,CAAC"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/hubsites/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,aAAa,EAEb,WAAW,EACd,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAErE,OAAO,EAAQ,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAEhD,qBACa,SAAU,SAAQ,aAAa,CAAC,YAAY,EAAE,CAAC;IAExD;;;;OAIG;IACI,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,QAAQ;CAIvC;AACD,MAAM,WAAW,SAAU,SAAQ,SAAS;CAAI;AAChD,eAAO,MAAM,QAAQ,4DAA2C,CAAC;AAEjE,qBAAa,QAAS,SAAQ,WAAW,CAAC,YAAY,CAAC;IAEnD;;OAEG;IACU,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC;CAIzC;AACD,MAAM,WAAW,QAAS,SAAQ,QAAQ;CAAI;AAC9C,eAAO,MAAM,OAAO,2DAAyC,CAAC;AAE9D,MAAM,WAAW,YAAY;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,OAAO,CAAC;IAC9B,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,oBAAoB,EAAE,OAAO,CAAC;IAC9B,qBAAqB,EAAE,OAAO,CAAC;CAClC;AAED,MAAM,WAAW,eAAe;IAC5B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,sBAAsB,EAAE,OAAO,CAAC;IAChC,eAAe,EAAE,OAAO,CAAC;IACzB,UAAU,EAAE,2BAA2B,EAAE,CAAC;IAC1C,qBAAqB,EAAE,OAAO,CAAC;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,OAAO,CAAC;IAC9B,oBAAoB,EAAE,OAAO,CAAC;IAC9B,eAAe,EAAE,MAAM,CAAC;IACxB,iBAAiB,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CACtC"}

package/commonjs/hubsites/types.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HubSite = exports._HubSite = exports.HubSites = exports._HubSites = void 0;
+const tslib_1 = require("tslib");
+const spqueryable_js_1 = require("../spqueryable.js");
+const decorators_js_1 = require("../decorators.js");
+const types_js_1 = require("../sites/types.js");
+let _HubSites = class _HubSites extends spqueryable_js_1._SPCollection {
+    /**
+     * Gets a Hub Site from the collection by id
+     *
+     * @param id The Id of the Hub Site
+     */
+    getById(id) {
+        return (0, exports.HubSite)(this, `GetById?hubSiteId='${id}'`);
+    }
+};
+_HubSites = (0, tslib_1.__decorate)([
+    (0, decorators_js_1.defaultPath)("_api/hubsites")
+], _HubSites);
+exports._HubSites = _HubSites;
+exports.HubSites = (0, spqueryable_js_1.spInvokableFactory)(_HubSites);
+class _HubSite extends spqueryable_js_1._SPInstance {
+    /**
+     * Gets the ISite instance associated with this hubsite
+     */
+    async getSite() {
+        const d = await this.select("SiteUrl")();
+        return (0, types_js_1.Site)([this, d.SiteUrl]);
+    }
+}
+exports._HubSite = _HubSite;
+exports.HubSite = (0, spqueryable_js_1.spInvokableFactory)(_HubSite);
+//# sourceMappingURL=types.js.map

package/commonjs/hubsites/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../packages/sp/hubsites/types.ts"],"names":[],"mappings":";;;;AAAA,sDAI2B;AAE3B,oDAA+C;AAC/C,gDAAgD;AAGhD,IAAa,SAAS,GAAtB,MAAa,SAAU,SAAQ,8BAA6B;IAExD;;;;OAIG;IACI,OAAO,CAAC,EAAU;QACrB,OAAO,IAAA,eAAO,EAAC,IAAI,EAAE,sBAAsB,EAAE,GAAG,CAAC,CAAC;IAEtD,CAAC;CACJ,CAAA;AAXY,SAAS;IADrB,IAAA,2BAAW,EAAC,eAAe,CAAC;GAChB,SAAS,CAWrB;AAXY,8BAAS;AAaT,QAAA,QAAQ,GAAG,IAAA,mCAAkB,EAAY,SAAS,CAAC,CAAC;AAEjE,MAAa,QAAS,SAAQ,4BAAyB;IAEnD;;OAEG;IACI,KAAK,CAAC,OAAO;QAChB,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;QACzC,OAAO,IAAA,eAAI,EAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IACnC,CAAC;CACJ;AATD,4BASC;AAEY,QAAA,OAAO,GAAG,IAAA,mCAAkB,EAAW,QAAQ,CAAC,CAAC"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"web.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/hubsites/web.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAG7C,OAAO,QAAQ,eAAe,CAAC;IAC3B,UAAU,IAAI;QACV,WAAW,CAAC,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC;QACvE,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;KACrC;IACD,UAAU,IAAI;QAEV;;;;;;WAMG;QACH,WAAW,CAAC,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC;QAEvE;;WAEG;QACH,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;KACrC;CACJ"}

package/commonjs/hubsites/web.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const types_js_1 = require("../webs/types.js");
+const spqueryable_js_1 = require("../spqueryable.js");
+types_js_1._Web.prototype.hubSiteData = async function (forceRefresh = false) {
+    const data = await (0, types_js_1.Web)(this, `hubSiteData(${forceRefresh})`)();
+    if (typeof data === "string") {
+        return JSON.parse(data);
+    }
+    return data;
+};
+types_js_1._Web.prototype.syncHubSiteTheme = function () {
+    return (0, spqueryable_js_1.spPost)((0, types_js_1.Web)(this, "syncHubSiteTheme"));
+};
+//# sourceMappingURL=web.js.map

package/commonjs/hubsites/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../../../../packages/sp/hubsites/web.ts"],"names":[],"mappings":";;AAAA,+CAA6C;AAE7C,sDAA2C;AAyB3C,eAAI,CAAC,SAAS,CAAC,WAAW,GAAG,KAAK,WAAuB,YAAY,GAAG,KAAK;IACzE,MAAM,IAAI,GAAG,MAAM,IAAA,cAAG,EAAC,IAAI,EAAE,eAAe,YAAY,GAAG,CAAC,EAAmB,CAAC;IAChF,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;KAC3B;IACD,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF,eAAI,CAAC,SAAS,CAAC,gBAAgB,GAAG;IAC9B,OAAO,IAAA,uBAAM,EAAC,IAAA,cAAG,EAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC;AACjD,CAAC,CAAC"}

package/commonjs/index.d.ts

@@ -0,0 +1,15 @@
+export * from "./spqueryable.js";
+export * from "./decorators.js";
+export { SPFI, spfi, } from "./fi.js";
+export * from "./types.js";
+export * from "./utils/extract-web-url.js";
+export * from "./utils/file-names.js";
+export * from "./utils/odata-url-from.js";
+export * from "./utils/to-resource-path.js";
+export * from "./utils/encode-path-str.js";
+export * from "./behaviors/defaults.js";
+export * from "./behaviors/telemetry.js";
+export * from "./behaviors/request-digest.js";
+export * from "./behaviors/spbrowser.js";
+export * from "./behaviors/spfx.js";
+//# sourceMappingURL=index.d.ts.map

package/commonjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/sp/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AAEjC,cAAc,iBAAiB,CAAC;AAEhC,OAAO,EACH,IAAI,EACJ,IAAI,GACP,MAAM,SAAS,CAAC;AAEjB,cAAc,YAAY,CAAC;AAE3B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAE3C,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC"}

package/commonjs/index.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.spfi = exports.SPFI = void 0;
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./spqueryable.js"), exports);
+(0, tslib_1.__exportStar)(require("./decorators.js"), exports);
+var fi_js_1 = require("./fi.js");
+Object.defineProperty(exports, "SPFI", { enumerable: true, get: function () { return fi_js_1.SPFI; } });
+Object.defineProperty(exports, "spfi", { enumerable: true, get: function () { return fi_js_1.spfi; } });
+(0, tslib_1.__exportStar)(require("./types.js"), exports);
+(0, tslib_1.__exportStar)(require("./utils/extract-web-url.js"), exports);
+(0, tslib_1.__exportStar)(require("./utils/file-names.js"), exports);
+(0, tslib_1.__exportStar)(require("./utils/odata-url-from.js"), exports);
+(0, tslib_1.__exportStar)(require("./utils/to-resource-path.js"), exports);
+(0, tslib_1.__exportStar)(require("./utils/encode-path-str.js"), exports);
+(0, tslib_1.__exportStar)(require("./behaviors/defaults.js"), exports);
+(0, tslib_1.__exportStar)(require("./behaviors/telemetry.js"), exports);
+(0, tslib_1.__exportStar)(require("./behaviors/request-digest.js"), exports);
+(0, tslib_1.__exportStar)(require("./behaviors/spbrowser.js"), exports);
+(0, tslib_1.__exportStar)(require("./behaviors/spfx.js"), exports);
+//# sourceMappingURL=index.js.map

package/commonjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/sp/index.ts"],"names":[],"mappings":";;;;AAAA,gEAAiC;AAEjC,+DAAgC;AAEhC,iCAGiB;AAFb,6FAAA,IAAI,OAAA;AACJ,6FAAA,IAAI,OAAA;AAGR,0DAA2B;AAE3B,0EAA2C;AAC3C,qEAAsC;AACtC,yEAA0C;AAC1C,2EAA4C;AAC5C,0EAA2C;AAE3C,uEAAwC;AACxC,wEAAyC;AACzC,6EAA8C;AAC9C,wEAAyC;AACzC,mEAAoC"}

package/commonjs/items/index.d.ts

@@ -0,0 +1,3 @@
+import "./list.js";
+export { Item, Items, IItem, IItems, ItemVersion, ItemVersions, IItemVersion, IItemVersions, IItemAddResult, IItemUpdateResult, IItemUpdateResultData, IItemDeleteParams, IItemParentInfos, } from "./types.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/items/index.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,CAAC;AAEnB,OAAO,EACH,IAAI,EACJ,KAAK,EACL,KAAK,EACL,MAAM,EACN,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,cAAc,EACd,iBAAiB,EACjB,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,GACnB,MAAM,YAAY,CAAC"}

package/commonjs/items/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ItemVersions = exports.ItemVersion = exports.Items = exports.Item = void 0;
+require("./list.js");
+var types_js_1 = require("./types.js");
+Object.defineProperty(exports, "Item", { enumerable: true, get: function () { return types_js_1.Item; } });
+Object.defineProperty(exports, "Items", { enumerable: true, get: function () { return types_js_1.Items; } });
+Object.defineProperty(exports, "ItemVersion", { enumerable: true, get: function () { return types_js_1.ItemVersion; } });
+Object.defineProperty(exports, "ItemVersions", { enumerable: true, get: function () { return types_js_1.ItemVersions; } });
+//# sourceMappingURL=index.js.map

package/commonjs/items/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/sp/items/index.ts"],"names":[],"mappings":";;;AAAA,qBAAmB;AAEnB,uCAcoB;AAbhB,gGAAA,IAAI,OAAA;AACJ,iGAAA,KAAK,OAAA;AAGL,uGAAA,WAAW,OAAA;AACX,wGAAA,YAAY,OAAA"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"list.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/items/list.ts"],"names":[],"mappings":"AAEA,OAAO,EAAS,MAAM,EAAE,MAAM,YAAY,CAAC;AAE3C,OAAO,QAAQ,gBAAgB,CAAC;IAC5B,UAAU,KAAK;QACX,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;KAC1B;IACD,UAAU,KAAK;QACX,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;KAC1B;CACJ"}

package/commonjs/items/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, "items", types_js_2.Items);
+//# sourceMappingURL=list.js.map

package/commonjs/items/list.js.map

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

package/commonjs/items/types.d.ts

@@ -0,0 +1,193 @@
+import { _SPCollection, IDeleteableWithETag, _SPInstance, ISPQueryable, ISPInstance } from "../spqueryable.js";
+import { IListItemFormUpdateValue } from "../lists/types.js";
+import { IList } from "../lists/index.js";
+import { IResourcePath } from "../utils/to-resource-path.js";
+/**
+ * Describes a collection of Item objects
+ *
+ */
+export declare class _Items<GetType = any[]> extends _SPCollection<GetType> {
+    /**
+    * Gets an Item by id
+    *
+    * @param id The integer id of the item to retrieve
+    */
+    getById(id: number): IItem;
+    /**
+     * Gets BCS Item by string id
+     *
+     * @param stringId The string id of the BCS item to retrieve
+     */
+    getItemByStringId(stringId: string): IItem;
+    /**
+     * Skips the specified number of items (https://msdn.microsoft.com/en-us/library/office/fp142385.aspx#sectionSection6)
+     *
+     * @param skip The starting id where the page should start, use with top to specify pages
+     * @param reverse It true the PagedPrev=true parameter is added allowing backwards navigation in the collection
+     */
+    skip(skip: number, reverse?: boolean): this;
+    [Symbol.asyncIterator](): AsyncIterator<GetType, any, undefined>;
+    /**
+     * Adds a new item to the collection
+     *
+     * @param properties The new items's properties
+     * @param listItemEntityTypeFullName The type name of the list's entities
+     */
+    add(properties?: Record<string, any>): Promise<IItemAddResult>;
+}
+export interface IItems extends _Items {
+}
+export declare const Items: import("@pnp/sp").ISPInvokableFactory<IItems>;
+/**
+ * Descrines a single Item instance
+ *
+ */
+export declare class _Item extends _SPInstance {
+    delete: (this: ISPQueryable<any>, eTag?: string) => Promise<void>;
+    /**
+     * Gets the effective base permissions for the item
+     *
+     */
+    get effectiveBasePermissions(): ISPQueryable;
+    /**
+     * Gets the effective base permissions for the item in a UI context
+     *
+     */
+    get effectiveBasePermissionsForUI(): ISPQueryable;
+    /**
+     * Gets the field values for this list item in their HTML representation
+     *
+     */
+    get fieldValuesAsHTML(): ISPInstance;
+    /**
+     * Gets the field values for this list item in their text representation
+     *
+     */
+    get fieldValuesAsText(): ISPInstance;
+    /**
+     * Gets the field values for this list item for use in editing controls
+     *
+     */
+    get fieldValuesForEdit(): ISPInstance;
+    /**
+     * Gets the collection of versions associated with this item
+     */
+    get versions(): IItemVersions;
+    /**
+     * this item's list
+     */
+    get list(): IList;
+    /**
+     * Updates this list instance with the supplied properties
+     *
+     * @param properties A plain object hash of values to update for the list
+     * @param eTag Value used in the IF-Match header, by default "*"
+     */
+    update(properties: Record<string, any>, eTag?: string): Promise<IItemUpdateResult>;
+    /**
+     * Moves the list item to the Recycle Bin and returns the identifier of the new Recycle Bin item.
+     */
+    recycle(): Promise<string>;
+    /**
+     * Deletes the item object with options.
+     *
+     * @param parameters Specifies the options to use when deleting a item.
+     */
+    deleteWithParams(parameters: Partial<IItemDeleteParams>): Promise<void>;
+    /**
+     * Gets a string representation of the full URL to the WOPI frame.
+     * If there is no associated WOPI application, or no associated action, an empty string is returned.
+     *
+     * @param action Display mode: 0: view, 1: edit, 2: mobileView, 3: interactivePreview
+     */
+    getWopiFrameUrl(action?: number): Promise<string>;
+    /**
+     * Validates and sets the values of the specified collection of fields for the list item.
+     *
+     * @param formValues The fields to change and their new values.
+     * @param bNewDocumentUpdate true if the list item is a document being updated after upload; otherwise false.
+     */
+    validateUpdateListItem(formValues: IListItemFormUpdateValue[], bNewDocumentUpdate?: boolean): Promise<IListItemFormUpdateValue[]>;
+    /**
+     * Gets the parent information for this item's list and web
+     */
+    getParentInfos(): Promise<IItemParentInfos>;
+    setImageField(fieldName: string, imageName: string, imageContent: any): Promise<any>;
+}
+export interface IItem extends _Item, IDeleteableWithETag {
+}
+export declare const Item: import("@pnp/sp").ISPInvokableFactory<IItem>;
+/**
+ * Describes a collection of Version objects
+ *
+ */
+export declare class _ItemVersions extends _SPCollection {
+    /**
+     * Gets a version by id
+     *
+     * @param versionId The id of the version to retrieve
+     */
+    getById(versionId: number): IItemVersion;
+}
+export interface IItemVersions extends _ItemVersions {
+}
+export declare const ItemVersions: import("@pnp/sp").ISPInvokableFactory<IItemVersions>;
+/**
+ * Describes a single Version instance
+ *
+ */
+export declare class _ItemVersion extends _SPInstance {
+    delete: (this: ISPQueryable<any>, eTag?: string) => Promise<void>;
+}
+export interface IItemVersion extends _ItemVersion, IDeleteableWithETag {
+}
+export declare const ItemVersion: import("@pnp/sp").ISPInvokableFactory<IItemVersion>;
+export interface IPagedResult<T> {
+    value: T;
+    hasNext: boolean;
+    nextLink: string;
+}
+export interface IItemAddResult {
+    item: IItem;
+    data: any;
+}
+export interface IItemUpdateResult {
+    item: IItem;
+    data: IItemUpdateResultData;
+}
+export interface IItemUpdateResultData {
+    etag: string;
+}
+export interface IItemImageUploadResult {
+    Name: string;
+    ServerRelativeUrl: string;
+    UniqueId: string;
+}
+export interface IItemDeleteParams {
+    /**
+     * If true, delete or recycle a file when the LockType
+     * value is SPLockType.Shared or SPLockType.None.
+     * When false, delete or recycle the file when
+     * the LockType value SPLockType.None.
+     */
+    BypassSharedLock: boolean;
+}
+export interface IItemParentInfos {
+    Item: {
+        Id: string;
+    };
+    ParentList: {
+        Id: string;
+        Title: string;
+        RootFolderServerRelativePath: IResourcePath;
+        RootFolderServerRelativeUrl: string;
+        RootFolderUniqueId: string;
+    };
+    ParentWeb: {
+        Id: string;
+        ServerRelativePath: IResourcePath;
+        ServerRelativeUrl: string;
+        Url: string;
+    };
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/items/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,aAAa,EAEb,mBAAmB,EACnB,WAAW,EAGX,YAAY,EAEZ,WAAW,EAGd,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EAAE,wBAAwB,EAAQ,MAAM,mBAAmB,CAAC;AAEnE,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE1C,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAE7D;;;GAGG;AACH,qBACa,MAAM,CAAC,OAAO,GAAG,GAAG,EAAE,CAAE,SAAQ,aAAa,CAAC,OAAO,CAAC;IAE/D;;;;MAIE;IACK,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,KAAK;IAIjC;;;;OAIG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK;IAKjD;;;;;OAKG;IACI,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,UAAQ,GAAG,IAAI;IASzC,CAAC,MAAM,CAAC,aAAa,CAAC;IA8C7B;;;;;OAKG;IACU,GAAG,CAAC,UAAU,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM,GAAG,OAAO,CAAC,cAAc,CAAC;CAOlF;AACD,MAAM,WAAW,MAAO,SAAQ,MAAM;CAAI;AAC1C,eAAO,MAAM,KAAK,+CAAqC,CAAC;AAExD;;;GAGG;AACH,qBAAa,KAAM,SAAQ,WAAW;IAE3B,MAAM,4DAAwB;IAErC;;;OAGG;IACH,IAAW,wBAAwB,IAAI,YAAY,CAElD;IAED;;;OAGG;IACH,IAAW,6BAA6B,IAAI,YAAY,CAEvD;IAED;;;OAGG;IACH,IAAW,iBAAiB,IAAI,WAAW,CAE1C;IAED;;;OAGG;IACH,IAAW,iBAAiB,IAAI,WAAW,CAE1C;IAED;;;OAGG;IACH,IAAW,kBAAkB,IAAI,WAAW,CAE3C;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,aAAa,CAEnC;IAED;;OAEG;IACH,IAAW,IAAI,IAAI,KAAK,CAEvB;IAED;;;;;OAKG;IACU,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,IAAI,SAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAe5F;;OAEG;IACI,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;IAIjC;;;;OAIG;IACU,gBAAgB,CAAC,UAAU,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpF;;;;;OAKG;IACU,eAAe,CAAC,MAAM,SAAI,GAAG,OAAO,CAAC,MAAM,CAAC;IAOzD;;;;;OAKG;IACI,sBAAsB,CAAC,UAAU,EAAE,wBAAwB,EAAE,EAAE,kBAAkB,UAAQ,GAAG,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAItI;;OAEG;IACU,cAAc,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAuC3C,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;CA+BpG;AACD,MAAM,WAAW,KAAM,SAAQ,KAAK,EAAE,mBAAmB;CAAI;AAC7D,eAAO,MAAM,IAAI,8CAAmC,CAAC;AAErD;;;GAGG;AACH,qBACa,aAAc,SAAQ,aAAa;IAC5C;;;;OAIG;IACI,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,YAAY;CAGlD;AACD,MAAM,WAAW,aAAc,SAAQ,aAAa;CAAI;AACxD,eAAO,MAAM,YAAY,sDAAmD,CAAC;AAE7E;;;GAGG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAClC,MAAM,4DAAwB;CACxC;AACD,MAAM,WAAW,YAAa,SAAQ,YAAY,EAAE,mBAAmB;CAAI;AAC3E,eAAO,MAAM,WAAW,qDAAiD,CAAC;AAE1E,MAAM,WAAW,YAAY,CAAC,CAAC;IAC3B,KAAK,EAAE,CAAC,CAAC;IACT,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CACpB;AAQD,MAAM,WAAW,cAAc;IAC3B,IAAI,EAAE,KAAK,CAAC;IACZ,IAAI,EAAE,GAAG,CAAC;CACb;AAED,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,KAAK,CAAC;IACZ,IAAI,EAAE,qBAAqB,CAAC;CAC/B;AAED,MAAM,WAAW,qBAAqB;IAClC,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAE9B;;;;;OAKG;IACH,gBAAgB,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE;QACF,EAAE,EAAE,MAAM,CAAC;KACd,CAAC;IACF,UAAU,EAAE;QACR,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,4BAA4B,EAAE,aAAa,CAAC;QAC5C,2BAA2B,EAAE,MAAM,CAAC;QACpC,kBAAkB,EAAE,MAAM,CAAC;KAC9B,CAAC;IACF,SAAS,EAAE;QACP,EAAE,EAAE,MAAM,CAAC;QACX,kBAAkB,EAAE,aAAa,CAAC;QAClC,iBAAiB,EAAE,MAAM,CAAC;QAC1B,GAAG,EAAE,MAAM,CAAC;KACf,CAAC;CACL"}