@lindle/sharepoint_requests 0.1.19 → 0.1.20

package/src/root/internal/userRequests.ts

@@ -1,14 +1,28 @@
 import { AxiosInstance } from 'axios';
-import { PersonField, UserPermision, UserProfile } from '../../types';
+import { PermissionLabel, PersonField, UserPermision, UserProfile } from '../../types';
 import { RequestContext } from './context';
 import { escapeODataStringLiteral } from './sharepointUrl';
 
 type RoleDefinition = {
+  Name: string;
+  Description: string;
+  Hidden: boolean;
+  Id: number;
+  Order: number;
+  RoleTypeKind: number;
   BasePermissions: {
     High: string;
+    Low: string;
   };
 };
 
+const PERMISSION_PRIORITY: PermissionLabel[] = [
+  'Full Control',
+  'Edit',
+  'Contribute',
+  'Read',
+];
+
 export async function typeAhead(
   instance: AxiosInstance,
   input: string,
@@ -70,24 +84,19 @@ export async function currentUserProperties(
   instance: AxiosInstance
 ): Promise<UserProfile> {
   const requestUrl = '_api/sp.userprofiles.peoplemanager/getmyproperties';
-  let profile: any = await instance.get(requestUrl);
+  const response = await instance.get(requestUrl);
 
-  profile = profile.data.d;
+  const profile = (response.data?.d ?? response.data) as UserProfile | undefined;
+  if (!profile) {
+    throw new Error('Unable to retrieve user profile.');
+  }
 
-  profile.UserProfileProperties.results.forEach(
+  profile.UserProfileProperties?.results?.forEach(
     (prop: { Key: string; Value: string }) => {
-      if (prop.Key === 'FirstName') {
-        profile.FirstName = prop.Value;
-      }
-      if (prop.Key === 'LastName') {
-        profile.LastName = prop.Value;
-      }
-      if (prop.Key === 'Country') {
-        profile.Country = prop.Value;
-      }
-      if (prop.Key === 'UserName') {
-        profile.UserName = prop.Value;
-      }
+      if (prop.Key === 'FirstName') profile.FirstName = prop.Value;
+      else if (prop.Key === 'LastName') profile.LastName = prop.Value;
+      else if (prop.Key === 'Country') profile.Country = prop.Value;
+      else if (prop.Key === 'UserName') profile.UserName = prop.Value;
     }
   );
 
@@ -109,33 +118,48 @@ export async function getSiteUser(
   return response.data.d;
 }
 
-export async function roleDefinitions(instance: AxiosInstance) {
-  const requestUrl = `_api/Web/RoleDefinitions`;
-  const response = await instance.get(requestUrl);
+async function roleDefinitions(instance: AxiosInstance): Promise<RoleDefinition[]> {
+  const response = await instance.get('_api/Web/RoleDefinitions');
   return response.data.d.results as RoleDefinition[];
 }
 
-export async function getEffectiveBasePermissions(instance: AxiosInstance) {
-  const requestUrl = `_api/Web/effectiveBasePermissions`;
-  const response = await instance.get(requestUrl);
+async function getEffectiveBasePermissions(
+  instance: AxiosInstance
+): Promise<{ High: string; Low: string }> {
+  const response = await instance.get('_api/Web/effectiveBasePermissions');
   return response.data.d.EffectiveBasePermissions;
 }
 
 export async function currentUserPermissions(
   context: RequestContext
 ): Promise<UserPermision> {
-  const { High } = await getEffectiveBasePermissions(context.instance);
+  const { High: userHigh, Low: userLow } = await getEffectiveBasePermissions(
+    context.instance
+  );
   const definitions = await roleDefinitions(context.instance);
 
-  const result = definitions.find(
-    ({ BasePermissions }: RoleDefinition) => BasePermissions.High === High
-  );
+  const userHighInt = parseInt(userHigh, 10);
+  const userLowInt = parseInt(userLow, 10);
+
+  const matching = definitions
+    .filter((def): def is RoleDefinition =>
+      PERMISSION_PRIORITY.includes(def.Name as PermissionLabel) &&
+      (userHighInt & parseInt(def.BasePermissions.High, 10)) === parseInt(def.BasePermissions.High, 10) &&
+      (userLowInt & parseInt(def.BasePermissions.Low, 10)) === parseInt(def.BasePermissions.Low, 10)
+    )
+    .sort(
+      (a, b) =>
+        PERMISSION_PRIORITY.indexOf(a.Name as PermissionLabel) -
+        PERMISSION_PRIORITY.indexOf(b.Name as PermissionLabel)
+    );
+
+  const result = matching[0];
 
   if (!result) {
     throw new Error(
-      `Unable to resolve current user permission for BasePermissions.High="${High}".`
+      `Unable to resolve current user permission. Effective: High="${userHigh}", Low="${userLow}"`
     );
   }
 
-  return result as UserPermision;
+  return result as unknown as UserPermision;
 }

package/src/types.ts

@@ -238,7 +238,7 @@ export type MultiPersonField = {
 
 export type PermissionLabel = 'Full Control' | 'Edit' | 'Contribute' | 'Read';
 
-export type UserPermision = {
+export type UserPermission = {
   BasePermissions: {
     High: string;
     Low: string;
@@ -255,7 +255,8 @@ export type UserPermision = {
   __metadata: Metadata;
 };
 
-export type UserPermission = UserPermision;
+/** @deprecated Use `UserPermission` instead. */
+export type UserPermision = UserPermission;
 
 export type CurrentUser = {
   Email: string;

package/dist/root/index.d.ts

@@ -1,163 +0,0 @@
-import { CreateAxiosDefaults as AxiosConfig } from 'axios';
-import { CreateFileProps, CurrentUser, DeleteFileProps, EmailProps, Field_Options, Folder_Options, ItemID, ListData, Options, PersonField, SHAREPOINT_VER, UploadFileProps, UserPermision, UserProfile } from '../types';
-import { sendEmail as sendEmailRequest } from './internal/emailRequests';
-type ListKey<T extends {
-    LISTS: Record<string, unknown>;
-}> = Extract<keyof T['LISTS'], string>;
-type EmailApi = ((from: string, to: string[] | string, subject: string | undefined, body: string) => ReturnType<typeof sendEmailRequest>) & {
-    send: (props: EmailProps) => ReturnType<typeof sendEmailRequest>;
-};
-declare class HTTPSharePointRequests<T extends {
-    LISTS: Record<string, unknown>;
-    FOLDERS?: Record<string, unknown>;
-}> {
-    private readonly baseURL;
-    private readonly instance;
-    private readonly listItemEntityTypeCache;
-    readonly email: EmailApi;
-    constructor(baseURL: string, config?: AxiosConfig);
-    private createContext;
-    private resolveListItemEntityTypeFullName;
-    private buildListScope;
-    /**
-     * @deprecated Use `from(listName, '2010')` instead.
-     */
-    list<K extends ListKey<T>>(listName: K): {
-        create: (data: ListData<T["LISTS"][K]>) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        get: (options?: Options<T["LISTS"][K], "2010">) => Promise<{
-            data: (T["LISTS"][K] & Partial<import("../types").SPItem2010>) | (T["LISTS"][K] & Partial<import("../types").SPItem2010>)[];
-            meta: {
-                url: URL;
-            };
-        }>;
-        update: (id: ItemID, data: ListData<T["LISTS"][K]>, digest?: string) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        delete: (id: ItemID) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        remove: (id: ItemID) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        createFile: (props: CreateFileProps) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        uploadFile: (props: UploadFileProps) => Promise<import("axios").AxiosResponse<any, any, {}> & {
-            itemId?: ItemID;
-        }>;
-        deleteFile: (props: DeleteFileProps) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        removeFile: (props: DeleteFileProps) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        fields: (options?: Field_Options<T["LISTS"][K], "2010">) => {
-            get: () => Promise<any>;
-        };
-        items: {
-            create: (data: ListData<T["LISTS"][K]>) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-            get: (options?: Options<T["LISTS"][K], "2010">) => Promise<{
-                data: (T["LISTS"][K] & Partial<import("../types").SPItem2010>) | (T["LISTS"][K] & Partial<import("../types").SPItem2010>)[];
-                meta: {
-                    url: URL;
-                };
-            }>;
-            update: (id: ItemID, data: ListData<T["LISTS"][K]>, digest?: string) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-            delete: (id: ItemID) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-            remove: (id: ItemID) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        };
-        files: {
-            attach: (props: CreateFileProps) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-            upload: (props: UploadFileProps) => Promise<import("axios").AxiosResponse<any, any, {}> & {
-                itemId?: ItemID;
-            }>;
-            delete: (props: DeleteFileProps) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-            remove: (props: DeleteFileProps) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        };
-    };
-    from<K extends ListKey<T>, V extends SHAREPOINT_VER = '2013'>(listName: K, sharepointVersion?: V): {
-        create: (data: ListData<T["LISTS"][K]>) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        get: (options?: Options<T["LISTS"][K], V>) => Promise<{
-            data: (T["LISTS"][K] & Partial<import("../types").SPItem<V>>) | (T["LISTS"][K] & Partial<import("../types").SPItem<V>>)[];
-            meta: {
-                url: URL;
-            };
-        }>;
-        update: (id: ItemID, data: ListData<T["LISTS"][K]>, digest?: string) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        delete: (id: ItemID) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        remove: (id: ItemID) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        createFile: (props: CreateFileProps) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        uploadFile: (props: UploadFileProps) => Promise<import("axios").AxiosResponse<any, any, {}> & {
-            itemId?: ItemID;
-        }>;
-        deleteFile: (props: DeleteFileProps) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        removeFile: (props: DeleteFileProps) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        fields: (options?: Field_Options<T["LISTS"][K], V>) => {
-            get: () => Promise<any>;
-        };
-        items: {
-            create: (data: ListData<T["LISTS"][K]>) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-            get: (options?: Options<T["LISTS"][K], V>) => Promise<{
-                data: (T["LISTS"][K] & Partial<import("../types").SPItem<V>>) | (T["LISTS"][K] & Partial<import("../types").SPItem<V>>)[];
-                meta: {
-                    url: URL;
-                };
-            }>;
-            update: (id: ItemID, data: ListData<T["LISTS"][K]>, digest?: string) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-            delete: (id: ItemID) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-            remove: (id: ItemID) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        };
-        files: {
-            attach: (props: CreateFileProps) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-            upload: (props: UploadFileProps) => Promise<import("axios").AxiosResponse<any, any, {}> & {
-                itemId?: ItemID;
-            }>;
-            delete: (props: DeleteFileProps) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-            remove: (props: DeleteFileProps) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        };
-    };
-    field<K extends ListKey<T>, V extends SHAREPOINT_VER = '2013'>(listName: K, fieldName?: Extract<keyof T['LISTS'][K], string>, sharepointVersion?: V): Promise<any>;
-    lists(options?: Options<Record<string, unknown>, '2013'>): {
-        get: () => Promise<{
-            data: (Record<string, unknown> & Partial<import("../types").SPItem2013>) | (Record<string, unknown> & Partial<import("../types").SPItem2013>)[];
-            meta: {
-                url: URL;
-            };
-        }>;
-    };
-    getDigest(): Promise<string>;
-    folders(options?: Folder_Options<Record<string, unknown>>): {
-        get: () => Promise<{
-            data: any;
-            meta: {
-                url: URL;
-            };
-        }>;
-    };
-    folder(folderName?: string | string[]): {
-        get: (options?: Folder_Options<Record<string, unknown>>) => Promise<{
-            data: any;
-            meta: {
-                url: URL;
-            };
-        }>;
-    };
-    users(options?: Options<Record<string, unknown>, '2013'>): {
-        get: () => Promise<{
-            data: (Record<string, unknown> & Partial<import("../types").SPItem2013>) | (Record<string, unknown> & Partial<import("../types").SPItem2013>)[];
-            meta: {
-                url: URL;
-            };
-        }>;
-    };
-    sendEmail(props: EmailProps): Promise<import("axios").AxiosResponse<{
-        d: {
-            SendEmail: null;
-        };
-    }, any, {}>>;
-    readonly user: {
-        properties: () => {
-            get: () => Promise<UserProfile>;
-        };
-        searchSiteUser: (searchValue: string) => Promise<any>;
-        searchUser: (input: string, filter?: string) => Promise<PersonField>;
-        current: () => {
-            get: () => Promise<CurrentUser>;
-        };
-        currentPermission: () => {
-            get: () => Promise<UserPermision>;
-        };
-    };
-    getCurrentUser(): Promise<CurrentUser>;
-    currentUserProperties(): Promise<UserProfile>;
-    currentUserPermission(): Promise<UserPermision>;
-}
-export default HTTPSharePointRequests;

package/dist/root/instance.d.ts

@@ -1,3 +0,0 @@
-import { CreateAxiosDefaults as AxiosConfig } from 'axios';
-export declare const instance: (baseURL: string, config?: AxiosConfig) => import("axios").AxiosInstance;
-export default instance;

package/dist/root/internal/context.d.ts

@@ -1,11 +0,0 @@
-import { AxiosInstance } from 'axios';
-import { SHAREPOINT_VER } from '../../types';
-export interface RequestContext<V extends SHAREPOINT_VER = '2013'> {
-    instance: AxiosInstance;
-    baseURL: string;
-    endpoint: string;
-    listName: string;
-    sharepointVersion: V;
-    listItemEntityTypeFullName?: string;
-    resolveListItemEntityType?: () => Promise<string>;
-}

package/dist/root/internal/digest.d.ts

@@ -1,2 +0,0 @@
-import { AxiosInstance } from 'axios';
-export declare function fetchDigest(instance: AxiosInstance, baseURL: string): Promise<string>;

package/dist/root/internal/emailRequests.d.ts

@@ -1,10 +0,0 @@
-import { AxiosResponse } from 'axios';
-import { EmailProps } from '../../types';
-import { RequestContext } from './context';
-type SendEmailResponse = AxiosResponse<{
-    d: {
-        SendEmail: null;
-    };
-}>;
-export declare function sendEmail(context: RequestContext, { From, To, Subject, Body }: EmailProps): Promise<SendEmailResponse>;
-export {};

package/dist/root/internal/listRequests/createAttachment.d.ts

@@ -1,3 +0,0 @@
-import { CreateFileProps, SHAREPOINT_VER } from '../../../types';
-import { RequestContext } from '../context';
-export declare function createAttachment<V extends SHAREPOINT_VER = '2013'>(context: RequestContext<V>, { file, itemId }: CreateFileProps): Promise<import("axios").AxiosResponse<any, any, {}>>;

package/dist/root/internal/listRequests/createListItem.d.ts

@@ -1,3 +0,0 @@
-import { ListData, SHAREPOINT_VER } from '../../../types';
-import { RequestContext } from '../context';
-export declare function createListItem<D = Record<string, unknown>, V extends SHAREPOINT_VER = '2013'>(context: RequestContext<V>, listData: ListData<D>): Promise<import("axios").AxiosResponse<any, any, {}>>;

package/dist/root/internal/listRequests/deleteFile.d.ts

@@ -1,3 +0,0 @@
-import { SHAREPOINT_VER, DeleteFileProps } from '../../../types';
-import { RequestContext } from '../context';
-export declare function deleteFile<V extends SHAREPOINT_VER = '2013'>(context: RequestContext<V>, { fileName, folderPath }: DeleteFileProps): Promise<import("axios").AxiosResponse<any, any, {}>>;

package/dist/root/internal/listRequests/deleteItem.d.ts

@@ -1,3 +0,0 @@
-import { SHAREPOINT_VER } from '../../../types';
-import { RequestContext } from '../context';
-export declare function deleteItem<V extends SHAREPOINT_VER = '2013'>(context: RequestContext<V>, id: number | string): Promise<import("axios").AxiosResponse<any, any, {}>>;

package/dist/root/internal/listRequests/getFiles.d.ts

@@ -1,8 +0,0 @@
-import { Folder_Options, SHAREPOINT_VER } from '../../../types';
-import { RequestContext } from '../context';
-export declare function getFiles<T, V extends SHAREPOINT_VER = '2013'>(context: RequestContext<V>, options?: Folder_Options<T>): Promise<{
-    data: any;
-    meta: {
-        url: URL;
-    };
-}>;

package/dist/root/internal/listRequests/getListItems.d.ts

@@ -1,8 +0,0 @@
-import { Options, SPItem, SHAREPOINT_VER } from '../../../types';
-import { RequestContext } from '../context';
-export declare function getListItems<K, V extends SHAREPOINT_VER = '2013'>(context: RequestContext<V>, options?: Options<K, V>): Promise<{
-    data: (K & Partial<SPItem<V>>) | (K & Partial<SPItem<V>>)[] | undefined;
-    meta: {
-        url: URL;
-    };
-}>;

package/dist/root/internal/listRequests/getOnly.d.ts

@@ -1,3 +0,0 @@
-import { AxiosInstance } from 'axios';
-import { Options, SHAREPOINT_VER } from '../../../types';
-export declare function getOnly<T, V extends SHAREPOINT_VER = '2013'>(instance: AxiosInstance, endpoint: string, options?: Options<T, V>): Promise<any>;

package/dist/root/internal/listRequests/index.d.ts

@@ -1,9 +0,0 @@
-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/dist/root/internal/listRequests/normalizePayload.d.ts

@@ -1,4 +0,0 @@
-import { ListData } from '../../../types';
-type AnyRecord = Record<string, unknown>;
-export declare function normalizeListPayload<D = Record<string, unknown>>(data: ListData<D>): AnyRecord;
-export {};

package/dist/root/internal/listRequests/updateListItem.d.ts

@@ -1,3 +0,0 @@
-import { ListData, SHAREPOINT_VER } from '../../../types';
-import { RequestContext } from '../context';
-export declare function updateListItem<D = Record<string, unknown>, V extends SHAREPOINT_VER = '2013'>(context: RequestContext<V>, id: number | string, data: ListData<D>, digest?: string): Promise<import("axios").AxiosResponse<any, any, {}>>;

package/dist/root/internal/listRequests/uploadFile.d.ts

@@ -1,6 +0,0 @@
-import { AxiosResponse } from 'axios';
-import { ItemID, SHAREPOINT_VER, UploadFileProps } from '../../../types';
-import { RequestContext } from '../context';
-export declare function uploadFile<V extends SHAREPOINT_VER = '2013'>(context: RequestContext<V>, { file, folderPath, overwrite }: UploadFileProps): Promise<AxiosResponse & {
-    itemId?: ItemID;
-}>;

package/dist/root/internal/listRequests/utils.d.ts

@@ -1,2 +0,0 @@
-export declare function buildLibraryPath(folderPath?: string | string[]): string;
-export declare function encodeFileName(fileName: string): string;

package/dist/root/internal/odata.d.ts

@@ -1,5 +0,0 @@
-import { Folder_Options, Options, SHAREPOINT_VER } from '../../types';
-type QueryableOptions<T, V extends SHAREPOINT_VER = '2013'> = Options<T, V> | Folder_Options<T>;
-export declare function buildODataParams<T, V extends SHAREPOINT_VER = '2013'>(options: QueryableOptions<T, V> | undefined, orderBySeparator?: ',' | ' '): Record<string, string | number>;
-export declare function appendParamsToUrl(baseUrl: URL, params: Record<string, string | number | undefined | null>): void;
-export {};

package/dist/root/internal/sharepointUrl.d.ts

@@ -1,2 +0,0 @@
-export declare function escapeODataStringLiteral(value: string): string;
-export declare function buildListByTitleEndpoint(listName: string): string;

package/dist/root/internal/userRequests.d.ts

@@ -1,15 +0,0 @@
-import { AxiosInstance } from 'axios';
-import { PersonField, UserPermision, UserProfile } from '../../types';
-import { RequestContext } from './context';
-type RoleDefinition = {
-    BasePermissions: {
-        High: string;
-    };
-};
-export declare function typeAhead(instance: AxiosInstance, input: string, filter?: string): Promise<PersonField>;
-export declare function currentUserProperties(instance: AxiosInstance): Promise<UserProfile>;
-export declare function getSiteUser(instance: AxiosInstance, searchValue: string): Promise<any>;
-export declare function roleDefinitions(instance: AxiosInstance): Promise<RoleDefinition[]>;
-export declare function getEffectiveBasePermissions(instance: AxiosInstance): Promise<any>;
-export declare function currentUserPermissions(context: RequestContext): Promise<UserPermision>;
-export {};