@pnp/sp 2.8.0 → 2.12.0

package/sphttpclient.d.ts

@@ -1,19 +1,19 @@
-import { IFetchOptions, IRequestClient, IHttpClientImpl, Runtime } from "@pnp/common";
-export declare class SPHttpClient implements IRequestClient {
-    protected _runtime: Runtime;
-    protected _impl: IHttpClientImpl;
-    protected _digestCache: IGetDigest;
-    constructor(runtime?: Runtime);
-    constructor(runtime?: Runtime, impl?: IHttpClientImpl);
-    fetch(url: string, options?: IFetchOptions): Promise<Response>;
-    fetchRaw(url: string, options?: IFetchOptions): Promise<Response>;
-    get(url: string, options?: IFetchOptions): Promise<Response>;
-    post(url: string, options?: IFetchOptions): Promise<Response>;
-    patch(url: string, options?: IFetchOptions): Promise<Response>;
-    delete(url: string, options?: IFetchOptions): Promise<Response>;
-}
-interface IGetDigest {
-    (webUrl: string): Promise<string>;
-}
-export {};
+import { IFetchOptions, IRequestClient, IHttpClientImpl, Runtime } from "@pnp/common";
+export declare class SPHttpClient implements IRequestClient {
+    protected _runtime: Runtime;
+    protected _impl: IHttpClientImpl;
+    protected _digestCache: IGetDigest;
+    constructor(runtime?: Runtime);
+    constructor(runtime?: Runtime, impl?: IHttpClientImpl);
+    fetch(url: string, options?: IFetchOptions): Promise<Response>;
+    fetchRaw(url: string, options?: IFetchOptions): Promise<Response>;
+    get(url: string, options?: IFetchOptions): Promise<Response>;
+    post(url: string, options?: IFetchOptions): Promise<Response>;
+    patch(url: string, options?: IFetchOptions): Promise<Response>;
+    delete(url: string, options?: IFetchOptions): Promise<Response>;
+}
+interface IGetDigest {
+    (webUrl: string): Promise<string>;
+}
+export {};
 //# sourceMappingURL=sphttpclient.d.ts.map

package/sphttpclient.js

@@ -1,190 +1,190 @@
-import { __awaiter, __generator } from "tslib";
-import { assign, mergeHeaders, getCtxCallback, combine, dateAdd, DefaultRuntime, Runtime, objectDefinedNotNull, } from "@pnp/common";
-import { extractWebUrl } from "./utils/extractweburl.js";
-import { tag } from "./telemetry.js";
-import { ODataParser, HttpRequestError } from "@pnp/odata";
-var SPHttpClient = /** @class */ (function () {
-    function SPHttpClient() {
-        // constructor(...args: [runtime: Runtime] | [impl: IHttpClientImpl, runtime?: Runtime]) {
-        var args = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            args[_i] = arguments[_i];
-        }
-        var _a;
-        this._runtime = args.length > 0 && args[0] instanceof Runtime ? args[0] : DefaultRuntime;
-        this._impl = args.length > 1 && objectDefinedNotNull(args[1]) ?
-            args[1] : ((_a = this._runtime.get("sp")) === null || _a === void 0 ? void 0 : _a.fetchClientFactory()) || null;
-        if (this._impl === null) {
-            throw Error("Could not generate fetchClientFactory in SPHttpClient.");
-        }
-        this._digestCache = getDigestFactory(this);
-    }
-    SPHttpClient.prototype.fetch = function (url, options) {
-        var _a;
-        if (options === void 0) { options = {}; }
-        return __awaiter(this, void 0, void 0, function () {
-            var opts, headers, methodName, clientTag, digest;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        opts = assign(options, { cache: "no-cache", credentials: "same-origin" }, true);
-                        headers = new Headers();
-                        // first we add the global headers so they can be overwritten by any passed in locally to this call
-                        mergeHeaders(headers, (_a = this._runtime.get("sp")) === null || _a === void 0 ? void 0 : _a.headers);
-                        // second we add the local options so we can overwrite the globals
-                        mergeHeaders(headers, options.headers);
-                        // lastly we apply any default headers we need that may not exist
-                        if (!headers.has("Accept")) {
-                            headers.append("Accept", "application/json");
-                        }
-                        if (!headers.has("Content-Type")) {
-                            headers.append("Content-Type", "application/json;odata=verbose;charset=utf-8");
-                        }
-                        if (!headers.has("X-ClientService-ClientTag")) {
-                            methodName = tag.getClientTag(headers);
-                            clientTag = "PnPCoreJS:2.8.0:" + methodName;
-                            if (clientTag.length > 32) {
-                                clientTag = clientTag.substr(0, 32);
-                            }
-                            headers.append("X-ClientService-ClientTag", clientTag);
-                        }
-                        opts = assign(opts, { headers: headers });
-                        if (!(opts.method && opts.method.toUpperCase() !== "GET" && !headers.has("X-RequestDigest") && !headers.has("Authorization"))) return [3 /*break*/, 2];
-                        return [4 /*yield*/, this._digestCache(extractWebUrl(url))];
-                    case 1:
-                        digest = _b.sent();
-                        headers.append("X-RequestDigest", digest);
-                        _b.label = 2;
-                    case 2: return [2 /*return*/, this.fetchRaw(url, opts)];
-                }
-            });
-        });
-    };
-    SPHttpClient.prototype.fetchRaw = function (url, options) {
-        var _this = this;
-        if (options === void 0) { options = {}; }
-        // here we need to normalize the headers
-        var rawHeaders = new Headers();
-        mergeHeaders(rawHeaders, options.headers);
-        options = assign(options, { headers: rawHeaders });
-        var retry = function (ctx) {
-            // handles setting the proper timeout for a retry
-            var setRetry = function (response) {
-                var delay;
-                if (response.headers.has("Retry-After")) {
-                    // if we have gotten a header, use that value as the delay value in seconds
-                    delay = parseInt(response.headers.get("Retry-After"), 10) * 1000;
-                }
-                else {
-                    // grab our current delay
-                    delay = ctx.delay;
-                    // Increment our counters.
-                    ctx.delay *= 2;
-                }
-                ctx.attempts++;
-                // If we have exceeded the retry count, reject.
-                if (ctx.retryCount <= ctx.attempts) {
-                    // eslint-disable-next-line max-len
-                    ctx.reject(new HttpRequestError("Retry count exceeded (" + ctx.retryCount + ") for request. Response status: [" + response.status + "] " + response.statusText, response));
-                }
-                else {
-                    // Set our retry timeout for {delay} milliseconds.
-                    setTimeout(getCtxCallback(_this, retry, ctx), delay);
-                }
-            };
-            // send the actual request
-            _this._impl.fetch(url, options).then(function (response) {
-                if (response.status === 429) {
-                    // we have been throttled
-                    setRetry(response);
-                }
-                else {
-                    ctx.resolve(response);
-                }
-            }).catch(function (response) {
-                if (response.status === 503 || response.status === 504) {
-                    // http status code 503 or 504, we can retry this
-                    setRetry(response);
-                }
-                else {
-                    ctx.reject(response);
-                }
-            });
-        };
-        return new Promise(function (resolve, reject) {
-            retry.call(_this, {
-                attempts: 0,
-                delay: 100,
-                reject: reject,
-                resolve: resolve,
-                retryCount: 7,
-            });
-        });
-    };
-    SPHttpClient.prototype.get = function (url, options) {
-        if (options === void 0) { options = {}; }
-        var opts = assign(options, { method: "GET" });
-        return this.fetch(url, opts);
-    };
-    SPHttpClient.prototype.post = function (url, options) {
-        if (options === void 0) { options = {}; }
-        var opts = assign(options, { method: "POST" });
-        return this.fetch(url, opts);
-    };
-    SPHttpClient.prototype.patch = function (url, options) {
-        if (options === void 0) { options = {}; }
-        var opts = assign(options, { method: "PATCH" });
-        return this.fetch(url, opts);
-    };
-    SPHttpClient.prototype.delete = function (url, options) {
-        if (options === void 0) { options = {}; }
-        var opts = assign(options, { method: "DELETE" });
-        return this.fetch(url, opts);
-    };
-    return SPHttpClient;
-}());
-export { SPHttpClient };
-// allows for the caching of digests across all HttpClient's which each have their own DigestCache wrapper.
-var digests = new Map();
-function getDigestFactory(client) {
-    var _this = this;
-    return function (webUrl) { return __awaiter(_this, void 0, void 0, function () {
-        var cachedDigest, now, url, headers, resp, parsed, newCachedDigest;
-        var _a, _b;
-        return __generator(this, function (_c) {
-            switch (_c.label) {
-                case 0:
-                    cachedDigest = digests.get(webUrl);
-                    if (cachedDigest !== undefined) {
-                        now = new Date();
-                        if (now < cachedDigest.expiration) {
-                            return [2 /*return*/, cachedDigest.value];
-                        }
-                    }
-                    url = combine(webUrl, "/_api/contextinfo");
-                    headers = {
-                        "Accept": "application/json;odata=verbose",
-                        "Content-Type": "application/json;odata=verbose;charset=utf-8",
-                    };
-                    return [4 /*yield*/, client.fetchRaw(url, {
-                            cache: "no-cache",
-                            credentials: "same-origin",
-                            headers: assign(headers, (_b = (_a = client._runtime.get("sp")) === null || _a === void 0 ? void 0 : _a.sp) === null || _b === void 0 ? void 0 : _b.headers, true),
-                            method: "POST",
-                        })];
-                case 1:
-                    resp = _c.sent();
-                    return [4 /*yield*/, (new ODataParser()).parse(resp).then(function (r) { return r.GetContextWebInformation; })];
-                case 2:
-                    parsed = _c.sent();
-                    newCachedDigest = {
-                        expiration: dateAdd(new Date(), "second", parsed.FormDigestTimeoutSeconds),
-                        value: parsed.FormDigestValue,
-                    };
-                    digests.set(webUrl, newCachedDigest);
-                    return [2 /*return*/, newCachedDigest.value];
-            }
-        });
-    }); };
-}
+import { __awaiter, __generator } from "tslib";
+import { assign, mergeHeaders, getCtxCallback, combine, dateAdd, DefaultRuntime, Runtime, objectDefinedNotNull, } from "@pnp/common";
+import { extractWebUrl } from "./utils/extractweburl.js";
+import { tag } from "./telemetry.js";
+import { ODataParser, HttpRequestError } from "@pnp/odata";
+var SPHttpClient = /** @class */ (function () {
+    function SPHttpClient() {
+        // constructor(...args: [runtime: Runtime] | [impl: IHttpClientImpl, runtime?: Runtime]) {
+        var args = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            args[_i] = arguments[_i];
+        }
+        var _a;
+        this._runtime = args.length > 0 && args[0] instanceof Runtime ? args[0] : DefaultRuntime;
+        this._impl = args.length > 1 && objectDefinedNotNull(args[1]) ?
+            args[1] : ((_a = this._runtime.get("sp")) === null || _a === void 0 ? void 0 : _a.fetchClientFactory()) || null;
+        if (this._impl === null) {
+            throw Error("Could not generate fetchClientFactory in SPHttpClient.");
+        }
+        this._digestCache = getDigestFactory(this);
+    }
+    SPHttpClient.prototype.fetch = function (url, options) {
+        var _a;
+        if (options === void 0) { options = {}; }
+        return __awaiter(this, void 0, void 0, function () {
+            var opts, headers, methodName, clientTag, digest;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        opts = assign(options, { cache: "no-cache", credentials: "same-origin" }, true);
+                        headers = new Headers();
+                        // first we add the global headers so they can be overwritten by any passed in locally to this call
+                        mergeHeaders(headers, (_a = this._runtime.get("sp")) === null || _a === void 0 ? void 0 : _a.headers);
+                        // second we add the local options so we can overwrite the globals
+                        mergeHeaders(headers, options.headers);
+                        // lastly we apply any default headers we need that may not exist
+                        if (!headers.has("Accept")) {
+                            headers.append("Accept", "application/json");
+                        }
+                        if (!headers.has("Content-Type")) {
+                            headers.append("Content-Type", "application/json;odata=verbose;charset=utf-8");
+                        }
+                        if (!headers.has("X-ClientService-ClientTag")) {
+                            methodName = tag.getClientTag(headers);
+                            clientTag = "PnPCoreJS:2.12.0:" + methodName;
+                            if (clientTag.length > 32) {
+                                clientTag = clientTag.substr(0, 32);
+                            }
+                            headers.append("X-ClientService-ClientTag", clientTag);
+                        }
+                        opts = assign(opts, { headers: headers });
+                        if (!(opts.method && opts.method.toUpperCase() !== "GET" && !headers.has("X-RequestDigest") && !headers.has("Authorization"))) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this._digestCache(extractWebUrl(url))];
+                    case 1:
+                        digest = _b.sent();
+                        headers.append("X-RequestDigest", digest);
+                        _b.label = 2;
+                    case 2: return [2 /*return*/, this.fetchRaw(url, opts)];
+                }
+            });
+        });
+    };
+    SPHttpClient.prototype.fetchRaw = function (url, options) {
+        var _this = this;
+        if (options === void 0) { options = {}; }
+        // here we need to normalize the headers
+        var rawHeaders = new Headers();
+        mergeHeaders(rawHeaders, options.headers);
+        options = assign(options, { headers: rawHeaders });
+        var retry = function (ctx) {
+            // handles setting the proper timeout for a retry
+            var setRetry = function (response) {
+                var delay;
+                if (response.headers.has("Retry-After")) {
+                    // if we have gotten a header, use that value as the delay value in seconds
+                    delay = parseInt(response.headers.get("Retry-After"), 10) * 1000;
+                }
+                else {
+                    // grab our current delay
+                    delay = ctx.delay;
+                    // Increment our counters.
+                    ctx.delay *= 2;
+                }
+                ctx.attempts++;
+                // If we have exceeded the retry count, reject.
+                if (ctx.retryCount <= ctx.attempts) {
+                    // eslint-disable-next-line max-len
+                    ctx.reject(new HttpRequestError("Retry count exceeded (" + ctx.retryCount + ") for request. Response status: [" + response.status + "] " + response.statusText, response));
+                }
+                else {
+                    // Set our retry timeout for {delay} milliseconds.
+                    setTimeout(getCtxCallback(_this, retry, ctx), delay);
+                }
+            };
+            // send the actual request
+            _this._impl.fetch(url, options).then(function (response) {
+                if (response.status === 429) {
+                    // we have been throttled
+                    setRetry(response);
+                }
+                else {
+                    ctx.resolve(response);
+                }
+            }).catch(function (response) {
+                if (response.status === 503 || response.status === 504) {
+                    // http status code 503 or 504, we can retry this
+                    setRetry(response);
+                }
+                else {
+                    ctx.reject(response);
+                }
+            });
+        };
+        return new Promise(function (resolve, reject) {
+            retry.call(_this, {
+                attempts: 0,
+                delay: 100,
+                reject: reject,
+                resolve: resolve,
+                retryCount: 7,
+            });
+        });
+    };
+    SPHttpClient.prototype.get = function (url, options) {
+        if (options === void 0) { options = {}; }
+        var opts = assign(options, { method: "GET" });
+        return this.fetch(url, opts);
+    };
+    SPHttpClient.prototype.post = function (url, options) {
+        if (options === void 0) { options = {}; }
+        var opts = assign(options, { method: "POST" });
+        return this.fetch(url, opts);
+    };
+    SPHttpClient.prototype.patch = function (url, options) {
+        if (options === void 0) { options = {}; }
+        var opts = assign(options, { method: "PATCH" });
+        return this.fetch(url, opts);
+    };
+    SPHttpClient.prototype.delete = function (url, options) {
+        if (options === void 0) { options = {}; }
+        var opts = assign(options, { method: "DELETE" });
+        return this.fetch(url, opts);
+    };
+    return SPHttpClient;
+}());
+export { SPHttpClient };
+// allows for the caching of digests across all HttpClient's which each have their own DigestCache wrapper.
+var digests = new Map();
+function getDigestFactory(client) {
+    var _this = this;
+    return function (webUrl) { return __awaiter(_this, void 0, void 0, function () {
+        var cachedDigest, now, url, headers, resp, parsed, newCachedDigest;
+        var _a, _b;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
+                case 0:
+                    cachedDigest = digests.get(webUrl);
+                    if (cachedDigest !== undefined) {
+                        now = new Date();
+                        if (now < cachedDigest.expiration) {
+                            return [2 /*return*/, cachedDigest.value];
+                        }
+                    }
+                    url = combine(webUrl, "/_api/contextinfo");
+                    headers = {
+                        "Accept": "application/json;odata=verbose",
+                        "Content-Type": "application/json;odata=verbose;charset=utf-8",
+                    };
+                    return [4 /*yield*/, client.fetchRaw(url, {
+                            cache: "no-cache",
+                            credentials: "same-origin",
+                            headers: assign(headers, (_b = (_a = client._runtime.get("sp")) === null || _a === void 0 ? void 0 : _a.sp) === null || _b === void 0 ? void 0 : _b.headers, true),
+                            method: "POST",
+                        })];
+                case 1:
+                    resp = _c.sent();
+                    return [4 /*yield*/, (new ODataParser()).parse(resp).then(function (r) { return r.GetContextWebInformation; })];
+                case 2:
+                    parsed = _c.sent();
+                    newCachedDigest = {
+                        expiration: dateAdd(new Date(), "second", parsed.FormDigestTimeoutSeconds),
+                        value: parsed.FormDigestValue,
+                    };
+                    digests.set(webUrl, newCachedDigest);
+                    return [2 /*return*/, newCachedDigest.value];
+            }
+        });
+    }); };
+}
 //# sourceMappingURL=sphttpclient.js.map

package/splibconfig.d.ts

@@ -1,23 +1,23 @@
-import { ILibraryConfiguration, ITypedHash, IHttpClientImpl, Runtime } from "@pnp/common";
-export declare const emptyGuid = "00000000-0000-0000-0000-000000000000";
-export interface ISPConfigurationPart {
-    sp?: ISPConfigurationProps;
-}
-export interface ISPConfigurationProps {
-    /**
-     * Any headers to apply to all requests
-     */
-    headers?: ITypedHash<string>;
-    /**
-     * The base url used for all requests
-     */
-    baseUrl?: string;
-    /**
-     * Defines a factory method used to create fetch clients
-     */
-    fetchClientFactory?: () => IHttpClientImpl;
-}
-export interface ISPConfiguration extends ILibraryConfiguration, ISPConfigurationPart {
-}
-export declare function setup(config: ISPConfiguration, runtime?: Runtime): void;
+import { ILibraryConfiguration, ITypedHash, IHttpClientImpl, Runtime } from "@pnp/common";
+export declare const emptyGuid = "00000000-0000-0000-0000-000000000000";
+export interface ISPConfigurationPart {
+    sp?: ISPConfigurationProps;
+}
+export interface ISPConfigurationProps {
+    /**
+     * Any headers to apply to all requests
+     */
+    headers?: ITypedHash<string>;
+    /**
+     * The base url used for all requests
+     */
+    baseUrl?: string;
+    /**
+     * Defines a factory method used to create fetch clients
+     */
+    fetchClientFactory?: () => IHttpClientImpl;
+}
+export interface ISPConfiguration extends ILibraryConfiguration, ISPConfigurationPart {
+}
+export declare function setup(config: ISPConfiguration, runtime?: Runtime): void;
 //# sourceMappingURL=splibconfig.d.ts.map

package/splibconfig.js

@@ -1,14 +1,14 @@
-import { FetchClient, DefaultRuntime, onRuntimeCreate, } from "@pnp/common";
-export var emptyGuid = "00000000-0000-0000-0000-000000000000";
-onRuntimeCreate(function (runtime) {
-    var existing = runtime.get("sp");
-    var spPart = Object.assign({}, {
-        fetchClientFactory: function () { return new FetchClient(); },
-    }, existing);
-    runtime.assign({ sp: spPart });
-});
-export function setup(config, runtime) {
-    if (runtime === void 0) { runtime = DefaultRuntime; }
-    runtime.assign(config);
-}
+import { FetchClient, DefaultRuntime, onRuntimeCreate, } from "@pnp/common";
+export var emptyGuid = "00000000-0000-0000-0000-000000000000";
+onRuntimeCreate(function (runtime) {
+    var existing = runtime.get("sp");
+    var spPart = Object.assign({}, {
+        fetchClientFactory: function () { return new FetchClient(); },
+    }, existing);
+    runtime.assign({ sp: spPart });
+});
+export function setup(config, runtime) {
+    if (runtime === void 0) { runtime = DefaultRuntime; }
+    runtime.assign(config);
+}
 //# sourceMappingURL=splibconfig.js.map

package/sputilities/index.d.ts

@@ -1,8 +1,8 @@
-import { IUtilities } from "./types.js";
-export { ICreateWikiPageResult, IEmailProperties, IUtilities, IWikiPageCreationInfo, Utilities, } from "./types.js";
-declare module "../rest" {
-    interface SPRest {
-        readonly utility: IUtilities;
-    }
-}
+import { IUtilities } from "./types.js";
+export { ICreateWikiPageResult, IEmailProperties, IUtilities, IWikiPageCreationInfo, Utilities, } from "./types.js";
+declare module "../rest" {
+    interface SPRest {
+        readonly utility: IUtilities;
+    }
+}
 //# sourceMappingURL=index.d.ts.map

package/sputilities/index.js

@@ -1,14 +1,14 @@
-import { SPRest } from "../rest.js";
-import { Utilities } from "./types.js";
-export { Utilities, } from "./types.js";
-Reflect.defineProperty(SPRest.prototype, "utility", {
-    configurable: true,
-    enumerable: true,
-    get: function () {
-        return this.childConfigHook(function (_a) {
-            var options = _a.options, baseUrl = _a.baseUrl, runtime = _a.runtime;
-            return Utilities(baseUrl, "").configure(options).setRuntime(runtime);
-        });
-    },
-});
+import { SPRest } from "../rest.js";
+import { Utilities } from "./types.js";
+export { Utilities, } from "./types.js";
+Reflect.defineProperty(SPRest.prototype, "utility", {
+    configurable: true,
+    enumerable: true,
+    get: function () {
+        return this.childConfigHook(function (_a) {
+            var options = _a.options, baseUrl = _a.baseUrl, runtime = _a.runtime;
+            return Utilities(baseUrl, "").configure(options).setRuntime(runtime);
+        });
+    },
+});
 //# sourceMappingURL=index.js.map