@lindle/sharepoint_requests 0.1.18 → 0.1.19

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

@@ -1,10 +1,24 @@
-import type { SHAREPOINT_VER } from '../../../types';
-import type { RequestContext } from '../context';
+import { SHAREPOINT_VER } from '../../../types';
+import { RequestContext } from '../context';
+import { fetchDigest } from '../digest';
+import { buildListByTitleEndpoint } from '../sharepointUrl';
 
 export async function deleteItem<V extends SHAREPOINT_VER = '2013'>(
   context: RequestContext<V>,
   id: number | string
 ) {
-  const response = await context.instance.delete(`${context.endpoint}(${id})`);
+  const requestDigest = await fetchDigest(context.instance, context.baseURL);
+  const url =
+    context.sharepointVersion === '2013'
+      ? `${buildListByTitleEndpoint(context.listName)}/items(${id})`
+      : `${context.endpoint}(${id})`;
+
+  const response = await context.instance.post(url, undefined, {
+    headers: {
+      'X-RequestDigest': requestDigest,
+      'IF-MATCH': '*',
+      'X-HTTP-Method': 'DELETE',
+    },
+  });
   return response;
 }

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

@@ -1,11 +1,8 @@
-import type { Folder_Options, SHAREPOINT_VER } from '../../../types';
+import { Folder_Options, SHAREPOINT_VER } from '../../../types';
 import { appendParamsToUrl, buildODataParams } from '../odata';
-import type { RequestContext } from '../context';
+import { RequestContext } from '../context';
 
-export async function getFiles<
-  T,
-  V extends SHAREPOINT_VER = '2013'
->(
+export async function getFiles<T, V extends SHAREPOINT_VER = '2013'>(
   context: RequestContext<V>,
   options?: Folder_Options<T>
 ) {
@@ -20,10 +17,7 @@ export async function getFiles<
     params,
   });
 
-  const data =
-    options?.limit || !response.data.d.results
-      ? response.data.d
-      : response.data.d.results;
+  const data = response.data?.d?.results ?? response.data?.d ?? response.data;
 
   const meta = { url };
 

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

@@ -1,14 +1,14 @@
-import type { Options, SPItem, SHAREPOINT_VER } from '../../../types';
+import { Options, SPItem, SHAREPOINT_VER } from '../../../types';
 import { appendParamsToUrl, buildODataParams } from '../odata';
-import type { RequestContext } from '../context';
+import { RequestContext } from '../context';
 
-export async function getListItems<
-  K,
-  V extends SHAREPOINT_VER = '2013'
->(
+export async function getListItems<K, V extends SHAREPOINT_VER = '2013'>(
   context: RequestContext<V>,
   options?: Options<K, V>
-): Promise<{ data: (K & Partial<SPItem<V>>)[]; meta: { url: URL } }> {
+): Promise<{
+  data: (K & Partial<SPItem<V>>) | (K & Partial<SPItem<V>>)[] | undefined;
+  meta: { url: URL };
+}> {
   const params = buildODataParams(options, ' ');
 
   const url = new URL(context.endpoint, context.instance.defaults.baseURL);
@@ -20,7 +20,8 @@ export async function getListItems<
     params,
   });
 
-  const rawData = response.data?.d?.results ?? response.data?.d ?? response.data;
+  const rawData =
+    response.data?.d?.results ?? response.data?.d ?? response.data;
   const cols = options?.cols;
   const keys = cols
     ? (Array.isArray(cols) ? cols : [cols]).filter(Boolean)
@@ -46,5 +47,11 @@ export async function getListItems<
 
   const meta = { url };
 
-  return { data: data as (K & Partial<SPItem<V>>)[], meta };
+  return {
+    data: data as
+      | (K & Partial<SPItem<V>>)
+      | (K & Partial<SPItem<V>>)[]
+      | undefined,
+    meta,
+  };
 }

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

@@ -1,18 +1,21 @@
-import type { AxiosInstance } from 'axios';
-import type { Options, SHAREPOINT_VER } from '../../../types';
+import { AxiosInstance } from 'axios';
+import { Options, SHAREPOINT_VER } from '../../../types';
 import { buildODataParams } from '../odata';
 
-export async function getOnly<
-  T,
-  V extends SHAREPOINT_VER = '2013'
->(
+export async function getOnly<T, V extends SHAREPOINT_VER = '2013'>(
   instance: AxiosInstance,
   endpoint: string,
   options?: Options<T, V>
 ) {
   const params = buildODataParams(options, ',');
   const { data } = await instance.get(endpoint, { params });
-  if (data) {
+  if (!data) {
+    return undefined;
+  }
+
+  if (data.d) {
     return data.d.results ? data.d.results : data.d;
   }
+
+  return data;
 }

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

@@ -1,4 +1,4 @@
-import type { ListData } from '../../../types';
+import { ListData } from '../../../types';
 
 type AnyRecord = Record<string, unknown>;
 

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

@@ -1,7 +1,8 @@
-import type { ListData, SHAREPOINT_VER } from '../../../types';
+import { ListData, SHAREPOINT_VER } from '../../../types';
 import { fetchDigest } from '../digest';
-import type { RequestContext } from '../context';
+import { RequestContext } from '../context';
 import { normalizeListPayload } from './normalizePayload';
+import { buildListByTitleEndpoint } from '../sharepointUrl';
 
 async function resolveMetadataType<V extends SHAREPOINT_VER>(
   context: RequestContext<V>
@@ -29,19 +30,28 @@ export async function updateListItem<
   const formDigestValue =
     digest || (await fetchDigest(context.instance, context.baseURL));
 
-  const metadataType = await resolveMetadataType(context);
   const normalizedData = normalizeListPayload(data);
-  const userMetadata = (data as { __metadata?: Record<string, unknown> })
-    .__metadata;
-  const payload = {
-    ...normalizedData,
-    __metadata: {
-      ...(userMetadata && typeof userMetadata === 'object' ? userMetadata : {}),
-      type: metadataType,
-    },
-  };
+  let payload: Record<string, unknown> = normalizedData;
+
+  if (context.sharepointVersion === '2013') {
+    const metadataType = await resolveMetadataType(context);
+    const userMetadata = (data as { __metadata?: Record<string, unknown> })
+      .__metadata;
+    payload = {
+      ...normalizedData,
+      __metadata: {
+        ...(userMetadata && typeof userMetadata === 'object'
+          ? userMetadata
+          : {}),
+        type: metadataType,
+      },
+    };
+  }
 
-  const url = `_api/lists/getbytitle('${context.listName}')/getItemById('${id}')`;
+  const url =
+    context.sharepointVersion === '2013'
+      ? `${buildListByTitleEndpoint(context.listName)}/items(${id})`
+      : `${context.endpoint}(${id})`;
 
   const response = await context.instance({
     url,
@@ -50,7 +60,7 @@ export async function updateListItem<
     headers: {
       'X-RequestDigest': formDigestValue,
       'IF-MATCH': '*',
-      'X-Http-Method': 'PATCH',
+      'X-HTTP-Method': 'MERGE',
     },
   });
 

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

@@ -1,12 +1,9 @@
-import type { AxiosResponse } from 'axios';
-import type {
-  ItemID,
-  SHAREPOINT_VER,
-  UploadFileProps,
-} from '../../../types';
+import { AxiosResponse } from 'axios';
+import { ItemID, SHAREPOINT_VER, UploadFileProps } from '../../../types';
 import { fetchDigest } from '../digest';
-import type { RequestContext } from '../context';
+import { RequestContext } from '../context';
 import { buildLibraryPath, encodeFileName } from './utils';
+import { buildListByTitleEndpoint } from '../sharepointUrl';
 
 const SUPPORTED_VERSION: SHAREPOINT_VER = '2013';
 
@@ -24,7 +21,7 @@ export async function uploadFile<V extends SHAREPOINT_VER = '2013'>(
     throw new Error('A file with a valid name must be provided.');
   }
 
-  let requestUrl = `_api/web/lists/getbytitle('${context.listName}')/RootFolder`;
+  let requestUrl = `${buildListByTitleEndpoint(context.listName)}/RootFolder`;
 
   requestUrl += buildLibraryPath(folderPath);
 

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

@@ -11,7 +11,7 @@ export function buildLibraryPath(folderPath?: string | string[]) {
     return '';
   }
 
-  const escapedSegments = segments.map((segment) => {
+  const escapedSegments = segments.map(segment => {
     if (!segment.trim()) {
       throw new Error('Folder path segments cannot be empty.');
     }

package/src/root/internal/odata.ts

@@ -1,4 +1,4 @@
-import type { Folder_Options, Options, SHAREPOINT_VER } from '../../types';
+import { Folder_Options, Options, SHAREPOINT_VER } from '../../types';
 
 type QueryableOptions<T, V extends SHAREPOINT_VER = '2013'> =
   | Options<T, V>
@@ -16,9 +16,7 @@ export function buildODataParams<T, V extends SHAREPOINT_VER = '2013'>(
     $skip: skip,
     $select: Array.isArray(cols) ? cols.join(',') : cols,
     $filter: filter,
-    $orderby: Array.isArray(orderBy)
-      ? orderBy.join(orderBySeparator)
-      : orderBy,
+    $orderby: Array.isArray(orderBy) ? orderBy.join(orderBySeparator) : orderBy,
   };
 
   return params;

package/src/root/internal/sharepointUrl.ts

@@ -0,0 +1,7 @@
+export function escapeODataStringLiteral(value: string) {
+  return value.replace(/'/g, "''");
+}
+
+export function buildListByTitleEndpoint(listName: string) {
+  return `_api/web/lists/GetByTitle('${escapeODataStringLiteral(listName)}')`;
+}

package/src/root/internal/userRequests.ts

@@ -1,10 +1,7 @@
-import type { AxiosInstance } from 'axios';
-import type {
-  PersonField,
-  UserPermision,
-  UserProfile,
-} from '../../types';
-import type { RequestContext } from './context';
+import { AxiosInstance } from 'axios';
+import { PersonField, UserPermision, UserProfile } from '../../types';
+import { RequestContext } from './context';
+import { escapeODataStringLiteral } from './sharepointUrl';
 
 type RoleDefinition = {
   BasePermissions: {
@@ -46,7 +43,27 @@ export async function typeAhead(
     },
   });
 
-  return response.data.d.ClientPeoplePickerSearchUser;
+  const searchResults =
+    response.data?.d?.ClientPeoplePickerSearchUser ??
+    response.data?.ClientPeoplePickerSearchUser;
+
+  if (typeof searchResults === 'string') {
+    const parsed = JSON.parse(searchResults);
+    if (Array.isArray(parsed) && parsed.length > 0) {
+      return parsed[0] as PersonField;
+    }
+    throw new Error('People picker returned no results.');
+  }
+
+  if (Array.isArray(searchResults) && searchResults.length > 0) {
+    return searchResults[0] as PersonField;
+  }
+
+  if (searchResults && typeof searchResults === 'object') {
+    return searchResults as PersonField;
+  }
+
+  throw new Error('Invalid people picker response.');
 }
 
 export async function currentUserProperties(
@@ -77,9 +94,18 @@ export async function currentUserProperties(
   return profile;
 }
 
-export async function getSiteUser(instance: AxiosInstance, searchValue: string) {
-  const requestUrl = `_api/web/siteusers?&$filter=substringof('${searchValue}', Title) or substringof('${searchValue}', LoginName) or substringof('${searchValue}', Email)&$top=50&$expand=Groups`;
-  const response = await instance.get(requestUrl);
+export async function getSiteUser(
+  instance: AxiosInstance,
+  searchValue: string
+) {
+  const safeSearchValue = escapeODataStringLiteral(searchValue);
+  const response = await instance.get('_api/web/siteusers', {
+    params: {
+      $filter: `substringof('${safeSearchValue}', Title) or substringof('${safeSearchValue}', LoginName) or substringof('${safeSearchValue}', Email)`,
+      $top: 50,
+      $expand: 'Groups',
+    },
+  });
   return response.data.d;
 }
 
@@ -105,5 +131,11 @@ export async function currentUserPermissions(
     ({ BasePermissions }: RoleDefinition) => BasePermissions.High === High
   );
 
+  if (!result) {
+    throw new Error(
+      `Unable to resolve current user permission for BasePermissions.High="${High}".`
+    );
+  }
+
   return result as UserPermision;
 }

package/src/types.ts

@@ -1,118 +1,119 @@
-export type Metadata = {
-  id?: string;
-  type?: string;
-  uri?: string;
-  etag?: string;
-};
-
-export type SPItem2010 = {
-  Attachments: string;
-  ContentType: string;
-  ContentTypeID: string;
-  Created: string;
-  CreatedBy: PersonField & _Deferred;
-  CreatedById: string;
-  Modified: string;
-  ModifiedBy: PersonField & _Deferred;
-  ModifiedById: string;
-  Id: number;
-  Title: string;
-  Path: string;
-  Version: string;
-  Owshiddenversion: number;
-  __metadata: Metadata;
-};
-
-export type SPItem2013 = {
-  __metadata: Metadata;
-  FirstUniqueAncestorSecurableObject: _Deferred;
-  RoleAssignments: _Deferred;
-  AttachmentFiles: _Deferred;
-  ContentType: _Deferred;
-  GetDlpPolicyTip: _Deferred;
-  FieldValuesAsHtml: _Deferred;
-  FieldValuesAsText: _Deferred;
-  FieldValuesForEdit: _Deferred;
-  File: _Deferred;
-  Folder: _Deferred;
-  ParentList: _Deferred;
-  FileSystemObjectType: number;
-  Id: number;
-  ContentTypeId: string;
-  Title: string;
-  PhotoRefId?: number;
-  ID: number;
-  Modified: string;
-  Created: string;
-  AuthorId: number;
-  EditorId: number;
-  OData__UIVersionString?: string;
-  Attachments: boolean;
-  GUID: string;
-  Author?: PersonField & _Deferred;
-  Editor?: PersonField & _Deferred;
-  [key: string]: unknown;
-};
-
-export type SPItem<V extends SHAREPOINT_VER = '2013'> = V extends '2010'
-  ? SPItem2010
-  : SPItem2013;
-
-type ListFields<K, V extends SHAREPOINT_VER = '2013'> =
-  | Extract<keyof K, string>
-  | Extract<keyof SPItem<V>, string>;
-
-export interface Options<K = any, V extends SHAREPOINT_VER = '2013'> {
-  expand?: ListFields<K, V>[] | ListFields<K, V>;
-  orderBy?: ListFields<K, V> | [ListFields<K, V>, 'asc' | 'desc'];
-  limit?: number;
-  filter?: string;
-  cols?: ListFields<K, V>[] | ListFields<K, V>;
+export type Metadata = {
+  id?: string;
+  type?: string;
+  uri?: string;
+  etag?: string;
+};
+
+export type SPItem2010 = {
+  Attachments: string;
+  ContentType: string;
+  ContentTypeID: string;
+  Created: string;
+  CreatedBy: PersonField & _Deferred;
+  CreatedById: string;
+  Modified: string;
+  ModifiedBy: PersonField & _Deferred;
+  ModifiedById: string;
+  Id: number;
+  Title: string;
+  Path: string;
+  Version: string;
+  Owshiddenversion: number;
+  __metadata: Metadata;
+};
+
+export type SPItem2013 = {
+  __metadata: Metadata;
+  FirstUniqueAncestorSecurableObject: _Deferred;
+  RoleAssignments: _Deferred;
+  AttachmentFiles: _Deferred;
+  ContentType: _Deferred;
+  GetDlpPolicyTip: _Deferred;
+  FieldValuesAsHtml: _Deferred;
+  FieldValuesAsText: _Deferred;
+  FieldValuesForEdit: _Deferred;
+  File: _Deferred;
+  Folder: _Deferred;
+  ParentList: _Deferred;
+  FileSystemObjectType: number;
+  Id: number;
+  ContentTypeId: string;
+  Title: string;
+  PhotoRefId?: number;
+  ID: number;
+  Modified: string;
+  Created: string;
+  AuthorId: number;
+  EditorId: number;
+  OData__UIVersionString?: string;
+  Attachments: boolean;
+  GUID: string;
+  Author?: PersonField & _Deferred;
+  Editor?: PersonField & _Deferred;
+  [key: string]: unknown;
+};
+
+export type SPItem<V extends SHAREPOINT_VER = '2013'> = V extends '2010'
+  ? SPItem2010
+  : SPItem2013;
+
+type ListFields<K, V extends SHAREPOINT_VER = '2013'> =
+  | Extract<keyof K, string>
+  | Extract<keyof SPItem<V>, string>;
+
+type OrderByDirection = 'asc' | 'desc';
+type OrderByExpression<F extends string> = F | (F | OrderByDirection)[];
+
+export interface Options<K = any, V extends SHAREPOINT_VER = '2013'> {
+  expand?: ListFields<K, V>[] | ListFields<K, V>;
+  orderBy?: OrderByExpression<ListFields<K, V>>;
+  limit?: number;
+  filter?: string;
+  cols?: ListFields<K, V>[] | ListFields<K, V>;
   skip?: number;
 }
 export interface Folder_Options<K = any> {
-  type: 'Files' | 'Folders';
+  type?: 'Files' | 'Folders';
   expand?: Extract<keyof K, string>[] | Extract<keyof K, string>;
-  orderBy?:
-    | Extract<keyof K, string>
-    | [Extract<keyof K, string>, 'asc' | 'desc'];
+  orderBy?: OrderByExpression<Extract<keyof K, string>>;
   limit?: number;
   filter?: string;
   cols?: Extract<keyof K, string>[] | Extract<keyof K, string>;
   skip?: number;
 }
 
-export interface Field_Options<
-  K,
-  V extends SHAREPOINT_VER = '2013'
-> extends Omit<Options<K, V>, 'filter'> {
-  fieldName?: Extract<keyof K, string>;
-}
+export interface Field_Options<K, V extends SHAREPOINT_VER = '2013'>
+  extends Omit<Options<K, V>, 'filter'> {
+  fieldName?: Extract<keyof K, string>;
+}
 
 export type SHAREPOINT_VER = '2010' | '2013';
 
-export type IListName<T> = Extract<keyof T, string>;
+export type IListName<T> = T extends { LISTS: Record<string, unknown> }
+  ? Extract<keyof T['LISTS'], string>
+  : Extract<keyof T, string>;
 
-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 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 EmailProps = {
-  From: string;
-  To: string[] | string;
-  Subject?: string;
-  Body: string;
+export type EmailProps = {
+  From: string;
+  To: string[] | string;
+  Subject?: string;
+  Body: string;
 };
 
 export type _Deferred = {
@@ -121,54 +122,55 @@ export type _Deferred = {
   };
 };
 
-declare const LOOKUP_FIELD_TAG: unique symbol;
-type LookupFieldMarker = {
-  [LOOKUP_FIELD_TAG]?: true;
-};
-
-export type LookupField<T> = _Deferred & T & LookupFieldMarker;
-export type ChoiceField<T> = _Deferred & {
-  Value: T;
-  __metadata: Metadata;
-};
-
-type MetadataEnvelope = {
-  __metadata?: {
-    type: string;
-  };
-};
-
-type EnsureRecord<T> = T extends Record<string, unknown>
-  ? T
-  : Record<string, unknown>;
-
-type LookupCreateValue =
-  | number
-  | string
-  | null
-  | {
-      lookupId: number | string;
-    }
-  | {
-      LookupId: number | string;
-    }
-  | {
-      results: (number | string)[];
-    };
-
-type NormalizeField<T> = T extends LookupField<unknown>
-  ? LookupCreateValue | LookupField<unknown>
-  : T;
-
-export type ListData<T = Record<string, unknown>> = Partial<{
-  [K in keyof EnsureRecord<T>]: NormalizeField<EnsureRecord<T>[K]>;
-}> &
-  MetadataEnvelope;
-
-export type PersonField = {
-  AboutMe?: string;
-  Account: string;
-  AccountName: string;
+type LookupFieldMarker = {
+  __lookupFieldBrand?: true;
+};
+
+export type LookupField<T> = _Deferred & T & LookupFieldMarker;
+export type ChoiceField<T> = _Deferred & {
+  Value: T;
+  __metadata: Metadata;
+};
+
+type MetadataEnvelope = {
+  __metadata?: {
+    type: string;
+  };
+};
+
+type EnsureRecord<T> = T extends Record<string, unknown>
+  ? T
+  : Record<string, unknown>;
+
+type LookupCreateValue =
+  | number
+  | string
+  | null
+  | {
+      lookupId: number | string;
+    }
+  | {
+      LookupId: number | string;
+    }
+  | {
+      results: (number | string)[];
+    };
+
+type NormalizeField<T> = T extends LookupField<unknown>
+  ? LookupCreateValue | LookupField<unknown>
+  : T;
+
+export type ListData<T = Record<string, unknown>> = Partial<
+  {
+    [K in keyof EnsureRecord<T>]: NormalizeField<EnsureRecord<T>[K]>;
+  }
+> &
+  MetadataEnvelope;
+
+export type PersonField = {
+  AboutMe?: string;
+  Account: string;
+  AccountName: string;
   AdministrativeSupervisor: string;
   AskMeAbout?: string;
   AskMeAbout0?: string;
@@ -253,6 +255,8 @@ export type UserPermision = {
   __metadata: Metadata;
 };
 
+export type UserPermission = UserPermision;
+
 export type CurrentUser = {
   Email: string;
   Id: number;