@pnp/nodejs 3.21.0-v3nightly.20231220 → 4.0.0-alpha0

package/package.json

@@ -1,37 +1,37 @@
 {
-  "name": "@pnp/nodejs",
-  "version": "3.21.0-v3nightly.20231220",
-  "description": "pnp - provides functionality enabling the @pnp libraries within nodejs",
-  "main": "./index.js",
-  "typings": "./index",
-  "dependencies": {
-    "@azure/msal-node": "1.18.4",
-    "@pnp/core": "3.21.0-v3nightly.20231220",
-    "@pnp/logging": "3.21.0-v3nightly.20231220",
-    "@pnp/queryable": "3.21.0-v3nightly.20231220",
-    "@pnp/sp": "3.21.0-v3nightly.20231220",
-    "@pnp/graph": "3.21.0-v3nightly.20231220",
-    "node-fetch": "3.3.2",
-    "tslib": "2.6.2"
-  },
-  "funding": {
-    "type": "individual",
-    "url": "https://github.com/sponsors/patrick-rodgers/"
-  },
-  "type": "module",
-  "engines": {
-    "node": ">=14.15.1"
-  },
-  "author": {
-    "name": "Microsoft and other contributors"
-  },
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/pnp/pnpjs/issues"
-  },
-  "homepage": "https://github.com/pnp/pnpjs",
-  "repository": {
-    "type": "git",
-    "url": "git:github.com/pnp/pnpjs"
-  }
+    "name": "@pnp/nodejs",
+    "version": "4.0.0-alpha0",
+    "description": "pnp - provides functionality enabling the @pnp libraries within nodejs",
+    "main": "./index.js",
+    "typings": "./index",
+    "dependencies": {
+        "@azure/msal-node": "1.18.3",
+        "@pnp/core": "4.0.0-alpha0",
+        "@pnp/logging": "4.0.0-alpha0",
+        "@pnp/queryable": "4.0.0-alpha0",
+        "@pnp/sp": "4.0.0-alpha0",
+        "@pnp/graph": "4.0.0-alpha0",
+        "node-fetch": "3.3.2",
+        "tslib": "2.6.2"
+    },
+    "funding": {
+        "type": "individual",
+        "url": "https://github.com/sponsors/patrick-rodgers/"
+    },
+    "type": "module",
+    "engines": {
+        "node": ">=14.15.1"
+    },
+    "author": {
+        "name": "Microsoft and other contributors"
+    },
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/pnp/pnpjs/issues"
+    },
+    "homepage": "https://github.com/pnp/pnpjs",
+    "repository": {
+        "type": "git",
+        "url": "git:github.com/pnp/pnpjs"
+    }
 }

package/sp-extensions/stream.d.ts

@@ -1,30 +1,7 @@
 /// <reference types="node" />
-import { IFileAddResult, IFileUploadProgressData } from "@pnp/sp/files/index.js";
-import { ReadStream } from "fs";
 import { PassThrough } from "stream";
 export interface IResponseBodyStream {
     body: PassThrough;
     knownLength: number;
 }
-declare type ProgressFunc = (data: IFileUploadProgressData) => void;
-declare type ChunkedResult = Promise<IFileAddResult>;
-declare module "@pnp/sp/files/types" {
-    interface IFile {
-        /**
-         * Gets a PassThrough stream representing the file
-         */
-        getStream(): Promise<IResponseBodyStream>;
-        /**
-         * Sets a file stream content chunk
-         */
-        setStreamContentChunked(stream: ReadStream, progress?: ProgressFunc): ChunkedResult;
-    }
-    interface IFiles {
-        /**
-         * Adds a file stream in chunks
-         */
-        addChunked(url: string, content: Blob | ReadStream, progress?: ProgressFunc, shouldOverWrite?: boolean, chunkSize?: number): ChunkedResult;
-    }
-}
-export {};
 //# sourceMappingURL=stream.d.ts.map

package/sp-extensions/stream.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../../../../packages/nodejs/sp-extensions/stream.ts"],"names":[],"mappings":";AACA,OAAO,EAAsB,cAAc,EAAU,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAE7G,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAKrC,MAAM,WAAW,mBAAmB;IAChC,IAAI,EAAE,WAAW,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACvB;AA2FD,aAAK,YAAY,GAAG,CAAC,IAAI,EAAE,uBAAuB,KAAK,IAAI,CAAC;AAC5D,aAAK,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;AAE7C,OAAO,QAAQ,qBAAqB,CAAC;IAEjC,UAAU,KAAK;QACX;;WAEG;QACH,SAAS,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAE1C;;WAEG;QACH,uBAAuB,CACnB,MAAM,EAAE,UAAU,EAClB,QAAQ,CAAC,EAAE,YAAY,GACxB,aAAa,CAAC;KACpB;IAED,UAAU,MAAM;QACZ;;WAEG;QACH,UAAU,CACN,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,IAAI,GAAG,UAAU,EAC1B,QAAQ,CAAC,EAAE,YAAY,EACvB,eAAe,CAAC,EAAE,OAAO,EACzB,SAAS,CAAC,EAAE,MAAM,GACnB,aAAa,CAAC;KACpB;CACJ"}
+{"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../../../../packages/nodejs/sp-extensions/stream.ts"],"names":[],"mappings":";AAIA,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAKrC,MAAM,WAAW,mBAAmB;IAChC,IAAI,EAAE,WAAW,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACvB"}

package/sp-extensions/stream.js

@@ -1,72 +1,104 @@
-import { asCancelableScope, CancelAction, headers } from "@pnp/queryable";
-import { File, Files } from "@pnp/sp/files/index.js";
-import { spPost, encodePath } from "@pnp/sp";
-import { extendFactory, getGUID, isFunc } from "@pnp/core";
-import { StreamParse } from "../behaviors/stream-parse.js";
-import { fileFromServerRelativePath } from "@pnp/sp/files/index.js";
-extendFactory(File, {
-    getStream() {
-        return File(this, "$value").using(StreamParse())(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
-     */
-    setStreamContentChunked: asCancelableScope(async function (stream, progress) {
-        if (!isFunc(progress)) {
-            progress = () => void (0);
-        }
-        const uploadId = getGUID();
-        const fileRef = File(this).using(CancelAction(() => {
-            return File(this).cancelUpload(uploadId);
-        }));
-        let blockNumber = -1;
-        let pointer = 0;
-        for await (const chunk of stream) {
-            blockNumber++;
-            progress({
-                uploadId,
-                blockNumber,
-                chunkSize: chunk.length,
-                currentPointer: pointer,
-                fileSize: -1,
-                stage: blockNumber === 0 ? "starting" : "continue",
-                totalBlocks: -1,
-            });
-            if (blockNumber === 0) {
-                pointer = await fileRef.startUpload(uploadId, chunk);
-            }
-            else {
-                pointer = await fileRef.continueUpload(uploadId, pointer, chunk);
-            }
-        }
-        progress({ uploadId, blockNumber, chunkSize: -1, currentPointer: -1, fileSize: -1, stage: "finishing", totalBlocks: -1 });
-        return await fileRef.finishUpload(uploadId, pointer, 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.
-     */
-    addChunked: asCancelableScope(async function (url, content, progress, shouldOverWrite = true, chunkSize = 10485760) {
-        const response = await spPost(Files(this, `add(overwrite=${shouldOverWrite},url='${encodePath(url)}')`));
-        const file = fileFromServerRelativePath(this, response.ServerRelativeUrl);
-        file.using(CancelAction(async () => {
-            return File(file).delete();
-        }));
-        if ("function" === typeof content.read) {
-            return file.setStreamContentChunked(content, progress);
-        }
-        return file.setContentChunked(content, progress, chunkSize);
-    }),
-});
+export {};
+// extendFactory(File, {
+//     getStream(): Promise<IResponseBodyStream> {
+//         return File(this, "$value").using(StreamParse())(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
+//      */
+//     setStreamContentChunked: asCancelableScope(async function (this: IFile, stream: ReadStream, progress?: (data: IFileUploadProgressData) => void): Promise<IFileAddResult> {
+//         if (!isFunc(progress)) {
+//             progress = () => void (0);
+//         }
+//         const uploadId = getGUID();
+//         const fileRef = File(this).using(CancelAction(() => {
+//             return File(this).cancelUpload(uploadId);
+//         }));
+//         let blockNumber = -1;
+//         let pointer = 0;
+//         for await (const chunk of stream) {
+//             blockNumber++;
+//             progress({
+//                 uploadId,
+//                 blockNumber,
+//                 chunkSize: chunk.length,
+//                 currentPointer: pointer,
+//                 fileSize: -1,
+//                 stage: blockNumber === 0 ? "starting" : "continue",
+//                 totalBlocks: -1,
+//             });
+//             if (blockNumber === 0) {
+//                 pointer = await fileRef.startUpload(uploadId, chunk);
+//             } else {
+//                 pointer = await fileRef.continueUpload(uploadId, pointer, chunk);
+//             }
+//         }
+//         progress({ uploadId, blockNumber, chunkSize: -1, currentPointer: -1, fileSize: -1, stage: "finishing", totalBlocks: -1 });
+//         return await fileRef.finishUpload(uploadId, pointer, 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.
+//      */
+//     addChunked: asCancelableScope(async function (
+//         this: IFiles,
+//         url: string,
+//         content: Blob | ReadStream,
+//         progress?: (data: IFileUploadProgressData) => void,
+//         shouldOverWrite = true,
+//         chunkSize = 10485760
+//     ) {
+//         const response = await spPost(Files(this, `add(overwrite=${shouldOverWrite},url='${encodePath(url)}')`));
+//         const file = fileFromServerRelativePath(this, response.ServerRelativeUrl);
+//         file.using(CancelAction(async () => {
+//             return File(file).delete();
+//         }));
+//         if ("function" === typeof (content as ReadStream).read) {
+//             return file.setStreamContentChunked(content as ReadStream, progress);
+//         }
+//         return file.setContentChunked(content as Blob, progress, chunkSize);
+//     }),
+// });
+// // these are needed to avoid a type/name not found issue where TSC doesn't properly keep
+// // the references used within the module declarations below
+// type ProgressFunc = (data: IFileUploadProgressData) => void;
+// type ChunkedResult = Promise<IFileAddResult>;
+// declare module "@pnp/sp/files/types" {
+//     interface IFile {
+//         /**
+//          * Gets a PassThrough stream representing the file
+//          */
+//         getStream(): Promise<IResponseBodyStream>;
+//         /**
+//          * Sets a file stream content chunk
+//          */
+//         setStreamContentChunked(
+//             stream: ReadStream,
+//             progress?: ProgressFunc,
+//         ): ChunkedResult;
+//     }
+//     interface IFiles {
+//         /**
+//          * Adds a file stream in chunks
+//          */
+//         addChunked(
+//             url: string,
+//             content: Blob | ReadStream,
+//             progress?: ProgressFunc,
+//             shouldOverWrite?: boolean,
+//             chunkSize?: number,
+//         ): ChunkedResult;
+//     }
+// }
 //# 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,iBAAiB,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC1E,OAAO,EAAE,IAAI,EAAE,KAAK,EAA0D,MAAM,wBAAwB,CAAC;AAC7G,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAG7C,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AAOpE,aAAa,CAAC,IAAI,EAAE;IAEhB,SAAS;QACL,OAAO,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,0BAA0B,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IACtG,CAAC;IAED;;;;;OAKG;IACH,uBAAuB,EAAE,iBAAiB,CAAC,KAAK,WAAwB,MAAkB,EAAE,QAAkD;QAE1I,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;YACnB,QAAQ,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC7B;QAED,MAAM,QAAQ,GAAG,OAAO,EAAE,CAAC;QAE3B,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,EAAE;YAC/C,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,WAAW,GAAG,CAAC,CAAC,CAAC;QACrB,IAAI,OAAO,GAAG,CAAC,CAAC;QAEhB,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,EAAE;YAC9B,WAAW,EAAE,CAAC;YACd,QAAQ,CAAC;gBACL,QAAQ;gBACR,WAAW;gBACX,SAAS,EAAE,KAAK,CAAC,MAAM;gBACvB,cAAc,EAAE,OAAO;gBACvB,QAAQ,EAAE,CAAC,CAAC;gBACZ,KAAK,EAAE,WAAW,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU;gBAClD,WAAW,EAAE,CAAC,CAAC;aAClB,CAAC,CAAC;YACH,IAAI,WAAW,KAAK,CAAC,EAAE;gBACnB,OAAO,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;aACxD;iBAAM;gBACH,OAAO,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;aACpE;SACJ;QAED,QAAQ,CAAC,EAAE,QAAQ,EAAE,WAAW,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;QAC1H,OAAO,MAAM,OAAO,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1E,CAAC,CAAC;CACL,CAAC,CAAC;AAEH,aAAa,CAAC,KAAK,EAAE;IAEjB;;;;;;;;;OASG;IACH,UAAU,EAAE,iBAAiB,CAAC,KAAK,WAE/B,GAAW,EACX,OAA0B,EAC1B,QAAkD,EAClD,eAAe,GAAG,IAAI,EACtB,SAAS,GAAG,QAAQ;QAGpB,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,iBAAiB,eAAe,SAAS,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QAEzG,MAAM,IAAI,GAAG,0BAA0B,CAAC,IAAI,EAAE,QAAQ,CAAC,iBAAiB,CAAC,CAAC;QAE1E,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YAC/B,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;QAC/B,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,UAAU,KAAK,OAAQ,OAAsB,CAAC,IAAI,EAAE;YACpD,OAAO,IAAI,CAAC,uBAAuB,CAAC,OAAqB,EAAE,QAAQ,CAAC,CAAC;SACxE;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAe,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IACxE,CAAC,CAAC;CACL,CAAC,CAAC"}
+{"version":3,"file":"stream.js","sourceRoot":"","sources":["../../../../packages/nodejs/sp-extensions/stream.ts"],"names":[],"mappings":";AAcA,wBAAwB;AAExB,kDAAkD;AAClD,6GAA6G;AAC7G,SAAS;AAET,UAAU;AACV,iGAAiG;AACjG,SAAS;AACT,+DAA+D;AAC/D,mGAAmG;AACnG,UAAU;AACV,iLAAiL;AAEjL,mCAAmC;AACnC,yCAAyC;AACzC,YAAY;AAEZ,sCAAsC;AAEtC,gEAAgE;AAChE,wDAAwD;AACxD,eAAe;AAEf,gCAAgC;AAChC,2BAA2B;AAE3B,8CAA8C;AAC9C,6BAA6B;AAC7B,yBAAyB;AACzB,4BAA4B;AAC5B,+BAA+B;AAC/B,2CAA2C;AAC3C,2CAA2C;AAC3C,gCAAgC;AAChC,sEAAsE;AACtE,mCAAmC;AACnC,kBAAkB;AAClB,uCAAuC;AACvC,wEAAwE;AACxE,uBAAuB;AACvB,oFAAoF;AACpF,gBAAgB;AAChB,YAAY;AAEZ,qIAAqI;AACrI,iFAAiF;AACjF,UAAU;AACV,MAAM;AAEN,yBAAyB;AAEzB,UAAU;AACV,oDAAoD;AACpD,SAAS;AACT,wDAAwD;AACxD,6EAA6E;AAC7E,mGAAmG;AACnG,sHAAsH;AACtH,oFAAoF;AACpF,qDAAqD;AACrD,UAAU;AACV,qDAAqD;AACrD,wBAAwB;AACxB,uBAAuB;AACvB,sCAAsC;AACtC,8DAA8D;AAC9D,kCAAkC;AAClC,+BAA+B;AAC/B,UAAU;AAEV,oHAAoH;AAEpH,qFAAqF;AAErF,gDAAgD;AAChD,0CAA0C;AAC1C,eAAe;AAEf,oEAAoE;AACpE,oFAAoF;AACpF,YAAY;AAEZ,+EAA+E;AAC/E,UAAU;AACV,MAAM;AAEN,2FAA2F;AAC3F,8DAA8D;AAC9D,+DAA+D;AAC/D,gDAAgD;AAEhD,yCAAyC;AAEzC,wBAAwB;AACxB,cAAc;AACd,6DAA6D;AAC7D,cAAc;AACd,qDAAqD;AAErD,cAAc;AACd,8CAA8C;AAC9C,cAAc;AACd,mCAAmC;AACnC,kCAAkC;AAClC,uCAAuC;AACvC,4BAA4B;AAC5B,QAAQ;AAER,yBAAyB;AACzB,cAAc;AACd,0CAA0C;AAC1C,cAAc;AACd,sBAAsB;AACtB,2BAA2B;AAC3B,0CAA0C;AAC1C,uCAAuC;AACvC,yCAAyC;AACzC,kCAAkC;AAClC,4BAA4B;AAC5B,QAAQ;AACR,IAAI"}