Merge pull request #2846 from bcameron1231/fix-2840

Add Missing parameter to AddUsingPath
pnp · Dec 1, 2023 · 74e4bd8 · 74e4bd8
2 parents 06be69f + df5c397
commit 74e4bd8
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/docs/sp/files.md b/docs/sp/files.md
@@ -134,6 +134,8 @@ Likewise you can add files using one of two methods, addUsingPath or addChunked.
 
 The addUsingPath method, supports the percent or pound characters in file names.
 
+When using EnsureUniqueFileName property, you must omit the Overwrite parameter.
+
 ```TypeScript
 import { spfi } from "@pnp/sp";
 import "@pnp/sp/webs";

diff --git a/packages/sp/files/types.ts b/packages/sp/files/types.ts
@@ -59,6 +59,9 @@ export class _Files extends _SPCollection<IFileInfo[]> {
             if (parameters.Overwrite) {
                 path.push(",Overwrite=true");
             }
+            if (parameters.EnsureUniqueFileName) {
+                path.push(`,EnsureUniqueFileName=${parameters.EnsureUniqueFileName}`);
+            }
             if (parameters.AutoCheckoutOnInvalidData) {
                 path.push(",AutoCheckoutOnInvalidData=true");
             }
@@ -703,7 +706,7 @@ export interface IAddUsingPathProps {
     /**
      * Overwrite the file if it exists
      */
-    Overwrite: boolean;
+    Overwrite?: boolean;
     /**
      * specifies whether to auto checkout on invalid Data. It'll be useful if the list contains validation whose requirements upload will not be able to meet.
      */
@@ -712,6 +715,10 @@ export interface IAddUsingPathProps {
      * Specifies a XOR hash of the file data which should be used to ensure end-2-end data integrity, base64 representation
      */
     XorHash?: string;
+    /**
+     * Specifies whether to force unique file name. When using this, omit the Overwrite parameter.
+     */
+    EnsureUniqueFileName?: boolean;
 }
 
 export interface IFileInfo {