@pnp/nodejs 2.8.0 → 2.12.0

package/sp-extensions/stream.js

@@ -1,107 +1,104 @@
-import { __awaiter, __extends, __generator } from "tslib";
-import { getGUID, isFunc, stringIsNullOrEmpty } from "@pnp/common";
-import { ODataParser, extendFactory, headers } from "@pnp/odata";
-import { File, Files } from "@pnp/sp/files/index.js";
-import { spPost, odataUrlFrom, escapeQueryStrValue } from "@pnp/sp";
-var StreamParser = /** @class */ (function (_super) {
-    __extends(StreamParser, _super);
-    function StreamParser() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    StreamParser.prototype.parseImpl = function (r, resolve) {
-        resolve({ body: r.body, knownLength: parseInt(r.headers.get("content-length"), 10) });
-    };
-    return StreamParser;
-}(ODataParser));
-export { StreamParser };
-extendFactory(File, {
-    getStream: function () {
-        return this.clone(File, "$value", false).usingParser(new StreamParser())(headers({ "binaryStringResponseBody": "true" }));
-    },
-    /**
-     * Sets the contents of a file using a chunked upload approach. Not supported in batching.
-     *
-     * @param stream The file to upload (as readable stream)
-     * @param progress A callback function which can be used to track the progress of the upload
-     * @param chunkSize The size of each file chunks, in bytes (default: 10485760)
-     */
-    setStreamContentChunked: function (stream, progress, chunkSize) {
-        if (chunkSize === void 0) { chunkSize = 10485760; }
-        return __awaiter(this, void 0, void 0, function () {
-            var uploadId, blockNumber, currentPointer, fileSize, totalBlocks, chunkBuffer;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (!isFunc(progress)) {
-                            progress = function () { return null; };
-                        }
-                        uploadId = getGUID();
-                        blockNumber = 1;
-                        currentPointer = 0;
-                        fileSize = null;
-                        totalBlocks = null;
-                        chunkBuffer = null;
-                        _a.label = 1;
-                    case 1:
-                        if (!(null !== (chunkBuffer = stream.read(chunkSize)))) return [3 /*break*/, 6];
-                        if (!(currentPointer === 0)) return [3 /*break*/, 3];
-                        progress({ uploadId: uploadId, blockNumber: blockNumber, chunkSize: chunkSize, currentPointer: currentPointer, fileSize: fileSize, stage: "starting", totalBlocks: totalBlocks });
-                        return [4 /*yield*/, this.startUpload(uploadId, chunkBuffer)];
-                    case 2:
-                        _a.sent();
-                        return [3 /*break*/, 5];
-                    case 3:
-                        progress({ uploadId: uploadId, blockNumber: blockNumber, chunkSize: chunkSize, currentPointer: currentPointer, fileSize: fileSize, stage: "continue", totalBlocks: totalBlocks });
-                        return [4 /*yield*/, this.continueUpload(uploadId, currentPointer, chunkBuffer)];
-                    case 4:
-                        _a.sent();
-                        _a.label = 5;
-                    case 5:
-                        blockNumber += 1;
-                        currentPointer += chunkBuffer.length;
-                        return [3 /*break*/, 1];
-                    case 6:
-                        progress({ uploadId: uploadId, blockNumber: blockNumber, chunkSize: chunkSize, currentPointer: currentPointer, fileSize: fileSize, stage: "finishing", totalBlocks: totalBlocks });
-                        return [2 /*return*/, this.finishUpload(uploadId, currentPointer, Buffer.from([]))];
-                }
-            });
-        });
-    },
-});
-extendFactory(Files, {
-    /**
-     * Uploads a file. Not supported for batching
-     *
-     * @param url The folder-relative url of the file
-     * @param content The Blob file content or File readable stream to add
-     * @param progress A callback function which can be used to track the progress of the upload
-     * @param shouldOverWrite Should a file with the same name in the same location be overwritten? (default: true)
-     * @param chunkSize The size of each file slice, in bytes (default: 10485760)
-     * @returns The new File and the raw response.
-     */
-    // @tag("fis.addChunked")
-    addChunked: function (url, content, progress, shouldOverWrite, chunkSize) {
-        if (shouldOverWrite === void 0) { shouldOverWrite = true; }
-        if (chunkSize === void 0) { chunkSize = 10485760; }
-        return __awaiter(this, void 0, void 0, function () {
-            var response, odataUrl, file;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, spPost(this.clone(Files, "add(overwrite=" + shouldOverWrite + ",url='" + escapeQueryStrValue(url) + "')", false))];
-                    case 1:
-                        response = _a.sent();
-                        odataUrl = odataUrlFrom(response);
-                        if (!stringIsNullOrEmpty(odataUrl) && /%27/i.test(odataUrl)) {
-                            odataUrl = odataUrl.replace(/%27/ig, "''");
-                        }
-                        file = File(odataUrl);
-                        if ("function" === typeof content.read) {
-                            return [2 /*return*/, file.setStreamContentChunked(content, progress, chunkSize)];
-                        }
-                        return [2 /*return*/, file.setContentChunked(content, progress, chunkSize)];
-                }
-            });
-        });
-    },
-});
+import { __awaiter, __extends, __generator } from "tslib";
+import { getGUID, isFunc, stringIsNullOrEmpty } from "@pnp/common";
+import { ODataParser, extendFactory, headers } from "@pnp/odata";
+import { File, Files } from "@pnp/sp/files/index.js";
+import { spPost, odataUrlFrom, escapeQueryStrValue } from "@pnp/sp";
+var StreamParser = /** @class */ (function (_super) {
+    __extends(StreamParser, _super);
+    function StreamParser() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    StreamParser.prototype.parseImpl = function (r, resolve) {
+        resolve({ body: r.body, knownLength: parseInt(r.headers.get("content-length"), 10) });
+    };
+    return StreamParser;
+}(ODataParser));
+export { StreamParser };
+extendFactory(File, {
+    getStream: function () {
+        return this.clone(File, "$value", false).usingParser(new StreamParser())(headers({ "binaryStringResponseBody": "true" }));
+    },
+    /**
+     * Sets the contents of a file using a chunked upload approach. Not supported in batching.
+     *
+     * @param stream The file to upload (as readable stream)
+     * @param progress A callback function which can be used to track the progress of the upload
+     * @param chunkSize The size of each file chunks, in bytes (default: 10485760)
+     */
+    setStreamContentChunked: function (stream, progress) {
+        return __awaiter(this, void 0, void 0, function () {
+            var uploadId, blockNumber, promise;
+            var _this = this;
+            return __generator(this, function (_a) {
+                if (!isFunc(progress)) {
+                    progress = function () { return null; };
+                }
+                uploadId = getGUID();
+                blockNumber = -1;
+                promise = Promise.resolve(0);
+                return [2 /*return*/, new Promise(function (resolve) {
+                        stream.on("data", function (chunk) {
+                            blockNumber += 1;
+                            if (blockNumber === 0) {
+                                promise = promise.then(function () {
+                                    progress({ uploadId: uploadId, blockNumber: blockNumber, chunkSize: chunk.length, currentPointer: 0, fileSize: -1, stage: "starting", totalBlocks: -1 });
+                                    return File(_this).startUpload(uploadId, chunk);
+                                });
+                            }
+                            else {
+                                promise = promise.then(function (cp) {
+                                    progress({ uploadId: uploadId, blockNumber: blockNumber, chunkSize: chunk.length, currentPointer: cp, fileSize: -1, stage: "continue", totalBlocks: -1 });
+                                    return File(_this).continueUpload(uploadId, cp, chunk);
+                                });
+                            }
+                        });
+                        stream.on("end", function () { return __awaiter(_this, void 0, void 0, function () {
+                            var _this = this;
+                            return __generator(this, function (_a) {
+                                progress({ uploadId: uploadId, blockNumber: blockNumber, chunkSize: -1, currentPointer: -1, fileSize: -1, stage: "finishing", totalBlocks: -1 });
+                                promise.then(function (cp) { return resolve(File(_this).finishUpload(uploadId, cp, Buffer.from([]))); });
+                                return [2 /*return*/];
+                            });
+                        }); });
+                    })];
+            });
+        });
+    },
+});
+extendFactory(Files, {
+    /**
+     * Uploads a file. Not supported for batching
+     *
+     * @param url The folder-relative url of the file
+     * @param content The Blob file content or File readable stream to add
+     * @param progress A callback function which can be used to track the progress of the upload
+     * @param shouldOverWrite Should a file with the same name in the same location be overwritten? (default: true)
+     * @param chunkSize The size of each file slice, in bytes (default: 10485760)
+     * @returns The new File and the raw response.
+     */
+    // @tag("fis.addChunked")
+    addChunked: function (url, content, progress, shouldOverWrite, chunkSize) {
+        if (shouldOverWrite === void 0) { shouldOverWrite = true; }
+        if (chunkSize === void 0) { chunkSize = 10485760; }
+        return __awaiter(this, void 0, void 0, function () {
+            var response, odataUrl, file;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, spPost(this.clone(Files, "add(overwrite=" + shouldOverWrite + ",url='" + escapeQueryStrValue(url) + "')", false))];
+                    case 1:
+                        response = _a.sent();
+                        odataUrl = odataUrlFrom(response);
+                        if (!stringIsNullOrEmpty(odataUrl) && /%27/i.test(odataUrl)) {
+                            odataUrl = odataUrl.replace(/%27/ig, "''");
+                        }
+                        file = File(odataUrl);
+                        if ("function" === typeof content.read) {
+                            return [2 /*return*/, file.setStreamContentChunked(content, progress, chunkSize)];
+                        }
+                        return [2 /*return*/, file.setContentChunked(content, progress, chunkSize)];
+                }
+            });
+        });
+    },
+});
 //# sourceMappingURL=stream.js.map

package/sp-extensions/stream.js.map

@@ -1 +1 @@
-{"version":3,"file":"stream.js","sourceRoot":"","sources":["../../../../../packages/nodejs/sp-extensions/stream.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACjE,OAAO,EAAE,IAAI,EAAE,KAAK,EAA8D,MAAM,wBAAwB,CAAC;AACjH,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AASpE;IAAkC,gCAAgC;IAAlE;;IAKA,CAAC;IAHa,gCAAS,GAAnB,UAAoB,CAAW,EAAE,OAA6B;QAC1D,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;IAC1F,CAAC;IACL,mBAAC;AAAD,CAAC,AALD,CAAkC,WAAW,GAK5C;;AAED,aAAa,CAAC,IAAI,EAAE;IAEhB,SAAS,EAAT;QACI,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,WAAW,CAAC,IAAI,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,0BAA0B,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC9H,CAAC;IAED;;;;;;OAMG;IACG,uBAAuB,EAA7B,UAA8B,MAAkB,EAAE,QAAkD,EAAE,SAAoB;QAApB,0BAAA,EAAA,oBAAoB;;;;;;wBACtH,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;4BACnB,QAAQ,GAAG,cAAM,OAAA,IAAI,EAAJ,CAAI,CAAC;yBACzB;wBAEK,QAAQ,GAAG,OAAO,EAAE,CAAC;wBACvB,WAAW,GAAG,CAAC,CAAC;wBAChB,cAAc,GAAG,CAAC,CAAC;wBAEjB,QAAQ,GAAW,IAAI,CAAC;wBAExB,WAAW,GAAW,IAAI,CAAC;wBAE7B,WAAW,GAAW,IAAI,CAAC;;;6BACxB,CAAA,IAAI,KAAK,CAAC,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;6BAC9C,CAAA,cAAc,KAAK,CAAC,CAAA,EAApB,wBAAoB;wBACpB,QAAQ,CAAC,EAAE,QAAQ,UAAA,EAAE,WAAW,aAAA,EAAE,SAAS,WAAA,EAAE,cAAc,gBAAA,EAAE,QAAQ,UAAA,EAAE,KAAK,EAAE,UAAU,EAAE,WAAW,aAAA,EAAE,CAAC,CAAC;wBACzG,qBAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,WAAW,CAAC,EAAA;;wBAA7C,SAA6C,CAAC;;;wBAE9C,QAAQ,CAAC,EAAE,QAAQ,UAAA,EAAE,WAAW,aAAA,EAAE,SAAS,WAAA,EAAE,cAAc,gBAAA,EAAE,QAAQ,UAAA,EAAE,KAAK,EAAE,UAAU,EAAE,WAAW,aAAA,EAAE,CAAC,CAAC;wBACzG,qBAAM,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,cAAc,EAAE,WAAW,CAAC,EAAA;;wBAAhE,SAAgE,CAAC;;;wBAErE,WAAW,IAAI,CAAC,CAAC;wBACjB,cAAc,IAAI,WAAW,CAAC,MAAM,CAAC;;;wBAGzC,QAAQ,CAAC,EAAE,QAAQ,UAAA,EAAE,WAAW,aAAA,EAAE,SAAS,WAAA,EAAE,cAAc,gBAAA,EAAE,QAAQ,UAAA,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,aAAA,EAAE,CAAC,CAAC;wBAC1G,sBAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAC;;;;KACvE;CACJ,CAAC,CAAC;AAEH,aAAa,CAAC,KAAK,EAAE;IAEjB;;;;;;;;;OASG;IACH,yBAAyB;IACnB,UAAU,EAAhB,UAEI,GAAW,EACX,OAA0B,EAC1B,QAAkD,EAClD,eAAsB,EACtB,SAAoB;QADpB,gCAAA,EAAA,sBAAsB;QACtB,0BAAA,EAAA,oBAAoB;;;;;4BAGQ,qBAAM,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,mBAAiB,eAAe,cAAS,mBAAmB,CAAC,GAAG,CAAC,OAAI,EAAE,KAAK,CAAC,CAAC,EAAA;;wBAAnI,QAAQ,GAAc,SAA6G;wBACrI,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;wBACtC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;4BACzD,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;yBAC9C;wBACK,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;wBAE5B,IAAI,UAAU,KAAK,OAAQ,OAAsB,CAAC,IAAI,EAAE;4BACpD,sBAAO,IAAI,CAAC,uBAAuB,CAAC,OAAqB,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAC;yBACnF;wBAED,sBAAO,IAAI,CAAC,iBAAiB,CAAC,OAAe,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAC;;;;KACvE;CACJ,CAAC,CAAC"}
+{"version":3,"file":"stream.js","sourceRoot":"","sources":["../../../../../packages/nodejs/sp-extensions/stream.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACjE,OAAO,EAAE,IAAI,EAAE,KAAK,EAA8D,MAAM,wBAAwB,CAAC;AACjH,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAUpE;IAAkC,gCAAgC;IAAlE;;IAKA,CAAC;IAHa,gCAAS,GAAnB,UAAoB,CAAW,EAAE,OAA6B;QAC1D,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;IAC1F,CAAC;IACL,mBAAC;AAAD,CAAC,AALD,CAAkC,WAAW,GAK5C;;AAED,aAAa,CAAC,IAAI,EAAE;IAEhB,SAAS,EAAT;QACI,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,WAAW,CAAC,IAAI,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,0BAA0B,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC9H,CAAC;IAED;;;;;;OAMG;IACG,uBAAuB,EAA7B,UAA2C,MAAkB,EAAE,QAAkD;;;;;gBAE7G,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;oBACnB,QAAQ,GAAG,cAAM,OAAA,IAAI,EAAJ,CAAI,CAAC;iBACzB;gBAEK,QAAQ,GAAG,OAAO,EAAE,CAAC;gBACvB,WAAW,GAAG,CAAC,CAAC,CAAC;gBACjB,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;gBAEjC,sBAAO,IAAI,OAAO,CAAC,UAAC,OAAO;wBAEvB,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,UAAC,KAAK;4BAEpB,WAAW,IAAI,CAAC,CAAC;4BAEjB,IAAI,WAAW,KAAK,CAAC,EAAE;gCAEnB,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;oCACnB,QAAQ,CAAC,EAAE,QAAQ,UAAA,EAAE,WAAW,aAAA,EAAE,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;oCAClI,OAAO,IAAI,CAAC,KAAI,CAAC,CAAC,WAAW,CAAC,QAAQ,EAAO,KAAK,CAAC,CAAC;gCACxD,CAAC,CAAC,CAAC;6BACN;iCAAM;gCAEH,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,UAAC,EAAE;oCACtB,QAAQ,CAAC,EAAE,QAAQ,UAAA,EAAE,WAAW,aAAA,EAAE,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,cAAc,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;oCACnI,OAAO,IAAI,CAAC,KAAI,CAAC,CAAC,cAAc,CAAC,QAAQ,EAAE,EAAE,EAAO,KAAK,CAAC,CAAC;gCAC/D,CAAC,CAAC,CAAC;6BACN;wBACL,CAAC,CAAC,CAAC;wBAEH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE;;;gCACb,QAAQ,CAAC,EAAE,QAAQ,UAAA,EAAE,WAAW,aAAA,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;gCAC1H,OAAO,CAAC,IAAI,CAAC,UAAC,EAAE,IAAK,OAAA,OAAO,CAAC,IAAI,CAAC,KAAI,CAAC,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAA/D,CAA+D,CAAC,CAAC;;;6BACzF,CAAC,CAAC;oBACP,CAAC,CAAC,EAAC;;;KACN;CACJ,CAAC,CAAC;AAEH,aAAa,CAAC,KAAK,EAAE;IAEjB;;;;;;;;;OASG;IACH,yBAAyB;IACnB,UAAU,EAAhB,UAEI,GAAW,EACX,OAA0B,EAC1B,QAAkD,EAClD,eAAsB,EACtB,SAAoB;QADpB,gCAAA,EAAA,sBAAsB;QACtB,0BAAA,EAAA,oBAAoB;;;;;4BAGQ,qBAAM,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,mBAAiB,eAAe,cAAS,mBAAmB,CAAC,GAAG,CAAC,OAAI,EAAE,KAAK,CAAC,CAAC,EAAA;;wBAAnI,QAAQ,GAAc,SAA6G;wBACrI,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;wBACtC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;4BACzD,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;yBAC9C;wBACK,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;wBAE5B,IAAI,UAAU,KAAK,OAAQ,OAAsB,CAAC,IAAI,EAAE;4BACpD,sBAAO,IAAI,CAAC,uBAAuB,CAAC,OAAqB,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAC;yBACnF;wBAED,sBAAO,IAAI,CAAC,iBAAiB,CAAC,OAAe,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAC;;;;KACvE;CACJ,CAAC,CAAC"}

package/sptokenutils.d.ts

@@ -1,12 +1,12 @@
-import { ITypedHash } from "@pnp/common";
-import { AuthToken } from "./types.js";
-export declare function validateProviderHostedRequestToken(requestToken: string, clientSecret: string): Promise<ITypedHash<string>>;
-/**
- * Gets an add-in only authentication token based on the supplied site url, client id and secret
- */
-export declare function getAddInOnlyAccessToken(siteUrl: string, clientId: string, clientSecret: string, realm: string, stsUri: string): Promise<AuthToken>;
-/**
- * Gets a user authentication token based on the supplied site url, client id, client secret, and refresh token
- */
-export declare function getUserAccessToken(siteUrl: string, clientId: string, clientSecret: string, refreshToken: string, realm: string, stsUri: string, cacheKey: string): Promise<AuthToken>;
+import { ITypedHash } from "@pnp/common";
+import { AuthToken } from "./types.js";
+export declare function validateProviderHostedRequestToken(requestToken: string, clientSecret: string): Promise<ITypedHash<string>>;
+/**
+ * Gets an add-in only authentication token based on the supplied site url, client id and secret
+ */
+export declare function getAddInOnlyAccessToken(siteUrl: string, clientId: string, clientSecret: string, realm: string, stsUri: string): Promise<AuthToken>;
+/**
+ * Gets a user authentication token based on the supplied site url, client id, client secret, and refresh token
+ */
+export declare function getUserAccessToken(siteUrl: string, clientId: string, clientSecret: string, refreshToken: string, realm: string, stsUri: string, cacheKey: string): Promise<AuthToken>;
 //# sourceMappingURL=sptokenutils.d.ts.map

package/sptokenutils.js

@@ -1,112 +1,112 @@
-import { __awaiter, __generator } from "tslib";
-import { parse } from "url";
-import * as jwt from "jsonwebtoken";
-import { SharePointServicePrincipal } from "./types.js";
-import { fetch } from "./net/fetch.js";
-var MapCacheManager = /** @class */ (function () {
-    function MapCacheManager() {
-        this.map = new Map();
-    }
-    MapCacheManager.prototype.getAccessToken = function (realm, cacheKey) {
-        return this.map.get(this.buildKey(realm, cacheKey));
-    };
-    MapCacheManager.prototype.setAccessToken = function (realm, cacheKey, token) {
-        this.map.set(this.buildKey(realm, cacheKey), token);
-    };
-    MapCacheManager.prototype.buildKey = function (realm, cacheKey) {
-        return realm + ":" + cacheKey;
-    };
-    return MapCacheManager;
-}());
-var tokenCache = new MapCacheManager();
-export function validateProviderHostedRequestToken(requestToken, clientSecret) {
-    return __awaiter(this, void 0, void 0, function () {
-        return __generator(this, function (_a) {
-            return [2 /*return*/, new Promise(function (resolve, reject) {
-                    var secret = Buffer.from(clientSecret, "base64");
-                    jwt.verify(requestToken, secret, function (err, decoded) {
-                        if (err) {
-                            return reject(err);
-                        }
-                        resolve(decoded);
-                    });
-                })];
-        });
-    });
-}
-/**
- * Gets an add-in only authentication token based on the supplied site url, client id and secret
- */
-export function getAddInOnlyAccessToken(siteUrl, clientId, clientSecret, realm, stsUri) {
-    return __awaiter(this, void 0, void 0, function () {
-        return __generator(this, function (_a) {
-            return [2 /*return*/, getTokenInternal({ siteUrl: siteUrl, clientId: clientId, clientSecret: clientSecret, refreshToken: null, realm: realm, stsUri: stsUri, cacheKey: "addinonly:" + clientId })];
-        });
-    });
-}
-/**
- * Gets a user authentication token based on the supplied site url, client id, client secret, and refresh token
- */
-// eslint-disable-next-line max-len
-export function getUserAccessToken(siteUrl, clientId, clientSecret, refreshToken, realm, stsUri, cacheKey) {
-    return getTokenInternal({ siteUrl: siteUrl, clientId: clientId, clientSecret: clientSecret, refreshToken: refreshToken, realm: realm, stsUri: stsUri, cacheKey: "user:" + cacheKey });
-}
-function getTokenInternal(params) {
-    return __awaiter(this, void 0, void 0, function () {
-        var accessToken, resource, formattedClientId, body, r;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    accessToken = tokenCache.getAccessToken(params.realm, params.cacheKey);
-                    if (accessToken && new Date() < toDate(accessToken.expires_on)) {
-                        return [2 /*return*/, accessToken];
-                    }
-                    resource = getFormattedPrincipal(SharePointServicePrincipal, parse(params.siteUrl).hostname, params.realm);
-                    formattedClientId = getFormattedPrincipal(params.clientId, "", params.realm);
-                    body = [];
-                    if (params.refreshToken) {
-                        body.push("grant_type=refresh_token");
-                        body.push("refresh_token=" + encodeURIComponent(params.refreshToken));
-                    }
-                    else {
-                        body.push("grant_type=client_credentials");
-                    }
-                    body.push("client_id=" + formattedClientId);
-                    body.push("client_secret=" + encodeURIComponent(params.clientSecret));
-                    body.push("resource=" + resource);
-                    return [4 /*yield*/, fetch(params.stsUri, {
-                            body: body.join("&"),
-                            headers: {
-                                "Content-Type": "application/x-www-form-urlencoded",
-                            },
-                            method: "POST",
-                        })];
-                case 1:
-                    r = _a.sent();
-                    return [4 /*yield*/, r.json()];
-                case 2:
-                    accessToken = _a.sent();
-                    tokenCache.setAccessToken(params.realm, params.cacheKey, accessToken);
-                    return [2 /*return*/, accessToken];
-            }
-        });
-    });
-}
-function getFormattedPrincipal(principalName, hostName, realm) {
-    var resource = principalName;
-    if (hostName !== null && hostName !== "") {
-        resource += "/" + hostName;
-    }
-    resource += "@" + realm;
-    return resource;
-}
-function toDate(epoch) {
-    var tmp = parseInt(epoch, 10);
-    if (tmp < 10000000000) {
-        tmp *= 1000;
-    }
-    var d = new Date();
-    d.setTime(tmp);
-    return d;
-}
+import { __awaiter, __generator } from "tslib";
+import { parse } from "url";
+import * as jwt from "jsonwebtoken";
+import { SharePointServicePrincipal } from "./types.js";
+import { fetch } from "./net/fetch.js";
+var MapCacheManager = /** @class */ (function () {
+    function MapCacheManager() {
+        this.map = new Map();
+    }
+    MapCacheManager.prototype.getAccessToken = function (realm, cacheKey) {
+        return this.map.get(this.buildKey(realm, cacheKey));
+    };
+    MapCacheManager.prototype.setAccessToken = function (realm, cacheKey, token) {
+        this.map.set(this.buildKey(realm, cacheKey), token);
+    };
+    MapCacheManager.prototype.buildKey = function (realm, cacheKey) {
+        return realm + ":" + cacheKey;
+    };
+    return MapCacheManager;
+}());
+var tokenCache = new MapCacheManager();
+export function validateProviderHostedRequestToken(requestToken, clientSecret) {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            return [2 /*return*/, new Promise(function (resolve, reject) {
+                    var secret = Buffer.from(clientSecret, "base64");
+                    jwt.verify(requestToken, secret, function (err, decoded) {
+                        if (err) {
+                            return reject(err);
+                        }
+                        resolve(decoded);
+                    });
+                })];
+        });
+    });
+}
+/**
+ * Gets an add-in only authentication token based on the supplied site url, client id and secret
+ */
+export function getAddInOnlyAccessToken(siteUrl, clientId, clientSecret, realm, stsUri) {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            return [2 /*return*/, getTokenInternal({ siteUrl: siteUrl, clientId: clientId, clientSecret: clientSecret, refreshToken: null, realm: realm, stsUri: stsUri, cacheKey: "addinonly:" + clientId })];
+        });
+    });
+}
+/**
+ * Gets a user authentication token based on the supplied site url, client id, client secret, and refresh token
+ */
+// eslint-disable-next-line max-len
+export function getUserAccessToken(siteUrl, clientId, clientSecret, refreshToken, realm, stsUri, cacheKey) {
+    return getTokenInternal({ siteUrl: siteUrl, clientId: clientId, clientSecret: clientSecret, refreshToken: refreshToken, realm: realm, stsUri: stsUri, cacheKey: "user:" + cacheKey });
+}
+function getTokenInternal(params) {
+    return __awaiter(this, void 0, void 0, function () {
+        var accessToken, resource, formattedClientId, body, r;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    accessToken = tokenCache.getAccessToken(params.realm, params.cacheKey);
+                    if (accessToken && new Date() < toDate(accessToken.expires_on)) {
+                        return [2 /*return*/, accessToken];
+                    }
+                    resource = getFormattedPrincipal(SharePointServicePrincipal, parse(params.siteUrl).hostname, params.realm);
+                    formattedClientId = getFormattedPrincipal(params.clientId, "", params.realm);
+                    body = [];
+                    if (params.refreshToken) {
+                        body.push("grant_type=refresh_token");
+                        body.push("refresh_token=" + encodeURIComponent(params.refreshToken));
+                    }
+                    else {
+                        body.push("grant_type=client_credentials");
+                    }
+                    body.push("client_id=" + formattedClientId);
+                    body.push("client_secret=" + encodeURIComponent(params.clientSecret));
+                    body.push("resource=" + resource);
+                    return [4 /*yield*/, fetch(params.stsUri, {
+                            body: body.join("&"),
+                            headers: {
+                                "Content-Type": "application/x-www-form-urlencoded",
+                            },
+                            method: "POST",
+                        })];
+                case 1:
+                    r = _a.sent();
+                    return [4 /*yield*/, r.json()];
+                case 2:
+                    accessToken = _a.sent();
+                    tokenCache.setAccessToken(params.realm, params.cacheKey, accessToken);
+                    return [2 /*return*/, accessToken];
+            }
+        });
+    });
+}
+function getFormattedPrincipal(principalName, hostName, realm) {
+    var resource = principalName;
+    if (hostName !== null && hostName !== "") {
+        resource += "/" + hostName;
+    }
+    resource += "@" + realm;
+    return resource;
+}
+function toDate(epoch) {
+    var tmp = parseInt(epoch, 10);
+    if (tmp < 10000000000) {
+        tmp *= 1000;
+    }
+    var d = new Date();
+    d.setTime(tmp);
+    return d;
+}
 //# sourceMappingURL=sptokenutils.js.map

package/types.d.ts

@@ -1,34 +1,34 @@
-export declare const SharePointServicePrincipal = "00000003-0000-0ff1-ce00-000000000000";
-export interface AADToken {
-    accessToken: string;
-    expiresIn: number;
-    expiresOn: string | Date;
-    isMRRT?: boolean;
-    resource: string;
-    tokenType: string;
-}
-export declare enum SPOAuthEnv {
-    SPO = 0,
-    China = 1,
-    Germany = 2,
-    USDef = 3,
-    USGov = 4
-}
-export interface AuthToken {
-    token_type: string;
-    expires_in: string;
-    not_before: string;
-    expires_on: string;
-    resource: string;
-    access_token: string;
-}
-export interface ProviderHostedConfigurationOptions {
-    headers: {
-        Authorization: string;
-    };
-}
-export interface ITokenCacheManager {
-    getAccessToken(realm: string, cacheKey: string): AuthToken;
-    setAccessToken(realm: string, cacheKey: string, token: AuthToken): void;
-}
+export declare const SharePointServicePrincipal = "00000003-0000-0ff1-ce00-000000000000";
+export interface AADToken {
+    accessToken: string;
+    expiresIn: number;
+    expiresOn: string | Date;
+    isMRRT?: boolean;
+    resource: string;
+    tokenType: string;
+}
+export declare enum SPOAuthEnv {
+    SPO = 0,
+    China = 1,
+    Germany = 2,
+    USDef = 3,
+    USGov = 4
+}
+export interface AuthToken {
+    token_type: string;
+    expires_in: string;
+    not_before: string;
+    expires_on: string;
+    resource: string;
+    access_token: string;
+}
+export interface ProviderHostedConfigurationOptions {
+    headers: {
+        Authorization: string;
+    };
+}
+export interface ITokenCacheManager {
+    getAccessToken(realm: string, cacheKey: string): AuthToken;
+    setAccessToken(realm: string, cacheKey: string, token: AuthToken): void;
+}
 //# sourceMappingURL=types.d.ts.map

package/types.js

@@ -1,10 +1,10 @@
-export var SharePointServicePrincipal = "00000003-0000-0ff1-ce00-000000000000";
-export var SPOAuthEnv;
-(function (SPOAuthEnv) {
-    SPOAuthEnv[SPOAuthEnv["SPO"] = 0] = "SPO";
-    SPOAuthEnv[SPOAuthEnv["China"] = 1] = "China";
-    SPOAuthEnv[SPOAuthEnv["Germany"] = 2] = "Germany";
-    SPOAuthEnv[SPOAuthEnv["USDef"] = 3] = "USDef";
-    SPOAuthEnv[SPOAuthEnv["USGov"] = 4] = "USGov";
-})(SPOAuthEnv || (SPOAuthEnv = {}));
+export var SharePointServicePrincipal = "00000003-0000-0ff1-ce00-000000000000";
+export var SPOAuthEnv;
+(function (SPOAuthEnv) {
+    SPOAuthEnv[SPOAuthEnv["SPO"] = 0] = "SPO";
+    SPOAuthEnv[SPOAuthEnv["China"] = 1] = "China";
+    SPOAuthEnv[SPOAuthEnv["Germany"] = 2] = "Germany";
+    SPOAuthEnv[SPOAuthEnv["USDef"] = 3] = "USDef";
+    SPOAuthEnv[SPOAuthEnv["USGov"] = 4] = "USGov";
+})(SPOAuthEnv || (SPOAuthEnv = {}));
 //# sourceMappingURL=types.js.map