@lindle/sharepoint_requests 0.1.14 → 0.1.16

package/src/root/internal/listRequests/createListItem.ts

@@ -2,30 +2,36 @@ import type { ListData, SHAREPOINT_VER } from '../../../types';
 import { fetchDigest } from '../digest';
 import type { RequestContext } from '../context';
 
-function transformArraysToEdmStrings(data: ListData) {
-  for (const key in data) {
-    if (Array.isArray(data[key])) {
-      data[key] = {
-        __metadata: { type: 'Collection(Edm.String)' },
-        results: data[key],
-      };
-    }
+async function resolveMetadataType<V extends SHAREPOINT_VER>(
+  context: RequestContext<V>
+) {
+  if (context.resolveListItemEntityType) {
+    return context.resolveListItemEntityType();
+  }
+
+  if (context.listItemEntityTypeFullName) {
+    return context.listItemEntityTypeFullName;
   }
+
+  return `SP.Data.${context.listName}ListItem`;
 }
 
 export async function createListItem<V extends SHAREPOINT_VER = '2013'>(
   context: RequestContext<V>,
   listData: ListData
 ) {
-  transformArraysToEdmStrings(listData);
-  listData.__metadata = {
-    type: `SP.Data.${context.listName}ListItem`,
+  const metadataType = await resolveMetadataType(context);
+  const payload = {
+    ...listData,
+    __metadata: {
+      type: metadataType,
+    },
   };
 
   const response = await context.instance({
     url: context.endpoint,
     method: 'POST',
-    data: JSON.stringify(listData),
+    data: JSON.stringify(payload),
     headers: {
       'X-RequestDigest': await fetchDigest(context.instance, context.baseURL),
     },

package/src/root/internal/listRequests/deleteFile.ts

@@ -0,0 +1,35 @@
+import type { SHAREPOINT_VER, DeleteFileProps } from '../../../types';
+import { fetchDigest } from '../digest';
+import type { RequestContext } from '../context';
+import { buildLibraryPath, encodeFileName } from './utils';
+
+const SUPPORTED_VERSION: SHAREPOINT_VER = '2013';
+
+export async function deleteFile<V extends SHAREPOINT_VER = '2013'>(
+  context: RequestContext<V>,
+  { fileName, folderPath }: DeleteFileProps
+) {
+  if (context.sharepointVersion !== SUPPORTED_VERSION) {
+    throw new Error(
+      'deleteFile is only supported for SharePoint 2013 REST endpoints.'
+    );
+  }
+
+  const encodedFileName = encodeFileName(fileName);
+  let requestUrl = `_api/web/lists/getbytitle('${context.listName}')/RootFolder`;
+  requestUrl += buildLibraryPath(folderPath);
+  requestUrl += `/Files('${encodedFileName}')`;
+
+  const digest = await fetchDigest(context.instance, context.baseURL);
+
+  const response = await context.instance.post(requestUrl, undefined, {
+    headers: {
+      'X-HTTP-Method': 'DELETE',
+      'IF-MATCH': '*',
+      'X-RequestDigest': digest,
+    },
+    withCredentials: true,
+  });
+
+  return response;
+}

package/src/root/internal/listRequests/index.ts

@@ -1,7 +1,9 @@
 export { createListItem } from './createListItem';
 export { createAttachment } from './createAttachment';
 export { deleteItem } from './deleteItem';
+export { deleteFile } from './deleteFile';
 export { getFiles } from './getFiles';
 export { getListItems } from './getListItems';
 export { getOnly } from './getOnly';
 export { updateListItem } from './updateListItem';
+export { uploadFile } from './uploadFile';

package/src/root/internal/listRequests/updateListItem.ts

@@ -2,6 +2,20 @@ import type { ListData, SHAREPOINT_VER } from '../../../types';
 import { fetchDigest } from '../digest';
 import type { RequestContext } from '../context';
 
+async function resolveMetadataType<V extends SHAREPOINT_VER>(
+  context: RequestContext<V>
+) {
+  if (context.resolveListItemEntityType) {
+    return context.resolveListItemEntityType();
+  }
+
+  if (context.listItemEntityTypeFullName) {
+    return context.listItemEntityTypeFullName;
+  }
+
+  return `SP.Data.${context.listName}ListItem`;
+}
+
 export async function updateListItem<V extends SHAREPOINT_VER = '2013'>(
   context: RequestContext<V>,
   id: number | string,
@@ -11,8 +25,12 @@ export async function updateListItem<V extends SHAREPOINT_VER = '2013'>(
   const formDigestValue =
     digest || (await fetchDigest(context.instance, context.baseURL));
 
-  data.__metadata = {
-    type: `SP.Data.${context.listName}ListItem`,
+  const metadataType = await resolveMetadataType(context);
+  const payload = {
+    ...data,
+    __metadata: {
+      type: metadataType,
+    },
   };
 
   const url = `_api/lists/getbytitle('${context.listName}')/getItemById('${id}')`;
@@ -20,7 +38,7 @@ export async function updateListItem<V extends SHAREPOINT_VER = '2013'>(
   const response = await context.instance({
     url,
     method: 'POST',
-    data: JSON.stringify(data),
+    data: JSON.stringify(payload),
     headers: {
       'X-RequestDigest': formDigestValue,
       'IF-MATCH': '*',

package/src/root/internal/listRequests/uploadFile.ts

@@ -0,0 +1,42 @@
+import type { SHAREPOINT_VER, UploadFileProps } from '../../../types';
+import { fetchDigest } from '../digest';
+import type { RequestContext } from '../context';
+import { buildLibraryPath, encodeFileName } from './utils';
+
+const SUPPORTED_VERSION: SHAREPOINT_VER = '2013';
+
+export async function uploadFile<V extends SHAREPOINT_VER = '2013'>(
+  context: RequestContext<V>,
+  { file, folderPath, overwrite = true }: UploadFileProps
+) {
+  if (context.sharepointVersion !== SUPPORTED_VERSION) {
+    throw new Error(
+      'uploadFile is only supported for SharePoint 2013 REST endpoints.'
+    );
+  }
+
+  if (!file?.name) {
+    throw new Error('A file with a valid name must be provided.');
+  }
+
+  let requestUrl = `_api/web/lists/getbytitle('${context.listName}')/RootFolder`;
+
+  requestUrl += buildLibraryPath(folderPath);
+
+  const encodedFileName = encodeFileName(file.name);
+  requestUrl += `/Files/add(url='${encodedFileName}',overwrite=${
+    overwrite ? 'true' : 'false'
+  })`;
+
+  const digest = await fetchDigest(context.instance, context.baseURL);
+
+  const response = await context.instance.post(requestUrl, file, {
+    headers: {
+      'Content-Type': file.type || 'application/octet-stream',
+      'X-RequestDigest': digest,
+    },
+    withCredentials: true,
+  });
+
+  return response;
+}

package/src/root/internal/listRequests/utils.ts

@@ -0,0 +1,33 @@
+export function buildLibraryPath(folderPath?: string | string[]) {
+  if (!folderPath) {
+    return '';
+  }
+
+  const segments = Array.isArray(folderPath)
+    ? folderPath
+    : folderPath.split('/').filter(Boolean);
+
+  if (!segments.length) {
+    return '';
+  }
+
+  const escapedSegments = segments.map((segment) => {
+    if (!segment.trim()) {
+      throw new Error('Folder path segments cannot be empty.');
+    }
+
+    const sanitized = segment.replace(/'/g, "''");
+
+    return `/Folders('${encodeURIComponent(sanitized)}')`;
+  });
+
+  return escapedSegments.join('');
+}
+
+export function encodeFileName(fileName: string) {
+  if (!fileName.trim()) {
+    throw new Error('File name cannot be empty.');
+  }
+
+  return encodeURIComponent(fileName.replace(/'/g, "''"));
+}

package/src/types.ts

@@ -93,11 +93,20 @@ export type SHAREPOINT_VER = '2010' | '2013';
 
 export type IListName<T> = Extract<keyof T, string>;
 
-export type ItemID = string | number;
-export type CreateFileProps = {
-  file: File;
-  itemId: ItemID;
-};
+export type ItemID = string | number;
+export type CreateFileProps = {
+  file: File;
+  itemId: ItemID;
+};
+export type UploadFileProps = {
+  file: File;
+  folderPath?: string | string[];
+  overwrite?: boolean;
+};
+export type DeleteFileProps = {
+  fileName: string;
+  folderPath?: string | string[];
+};
 
 export type ListData =
   | {