@lindle/sharepoint_requests 0.1.13 → 0.1.15

package/README.md

@@ -79,6 +79,10 @@ console.log('Item deleted successfully');
 const file = new File(['content'], 'example.txt');
 await sharepoint.from('ListName').createFile({ file, itemId: 1 });
 console.log('File uploaded successfully');
+
+const doc = new File(['doc content'], 'document.pdf');
+await sharepoint.from('Documents', '2013').uploadFile({ file: doc, folderPath: 'Shared/SubFolder' });
+console.log('Library file uploaded successfully');
 ```
 
 #### Send Emails
@@ -160,6 +164,7 @@ The package is fully typed, enabling autocompletion and type safety for all meth
 #### Files
 
 - `createFile({ file, itemId })` - Upload a file to a list item.
+- `uploadFile({ file, folderPath, overwrite })` - Upload a file to a document library (SharePoint 2013).
 
 ## Development
 

package/dist/index.d.ts

@@ -1,17 +1,17 @@
-import SHAREPOINT_REQUESTS from './root';
-import type { CreateAxiosDefaults as AxiosConfig } from 'axios';
-import type { LookupField, ChoiceField, PersonField } from './types';
-export default function createBase<T extends {
-    LISTS: Record<string, any>;
-    FOLDERS?: Record<string, any>;
-} = any>(): {
-    /**
-     * @deprecated Use `create` instead.
-     */
-    baseURL(url: string, config?: AxiosConfig): SHAREPOINT_REQUESTS<T>;
-    create: ({ baseURL, config, }: {
-        baseURL: string;
-        config?: AxiosConfig;
-    }) => SHAREPOINT_REQUESTS<T>;
-};
-export { LookupField, ChoiceField, PersonField };
+import SHAREPOINT_REQUESTS from './root';
+import type { CreateAxiosDefaults as AxiosConfig } from 'axios';
+import type { LookupField, ChoiceField, PersonField } from './types';
+export default function createBase<T extends {
+    LISTS: Record<string, any>;
+    FOLDERS?: Record<string, any>;
+} = any>(): {
+    /**
+     * @deprecated Use `create` instead.
+     */
+    baseURL(url: string, config?: AxiosConfig): SHAREPOINT_REQUESTS<T>;
+    create: ({ baseURL, config, }: {
+        baseURL: string;
+        config?: AxiosConfig;
+    }) => SHAREPOINT_REQUESTS<T>;
+};
+export { LookupField, ChoiceField, PersonField };

package/dist/root/index.d.ts

@@ -1,81 +1,85 @@
-import { CreateAxiosDefaults as AxiosConfig } from 'axios';
-import { CreateFileProps, CurrentUser, EmailProps, Field_Options, Folder_Options, IListName, ItemID, ListData, Options, PersonField, SHAREPOINT_VER, UserPermision, UserProfile } from '../types';
-declare class HTTPSharePointRequests<T extends {
-    LISTS: Record<string, unknown>;
-    FOLDERS?: Record<string, unknown>;
-}> {
-    private baseURL;
-    private endpoint;
-    private listName;
-    private instance;
-    private sharepointVersion;
-    constructor(baseURL: string, config?: AxiosConfig);
-    private getContext;
-    /**
-     * @deprecated Use `from` instead.
-     */
-    list(listName: IListName<T>): this;
-    readonly lists: {
-        get: () => Promise<{
-            data: Partial<import("../types").SPItem2013>[];
-            meta: {
-                url: URL;
-            };
-        }>;
-    };
-    from<K extends Extract<keyof T['LISTS'], string>, V extends SHAREPOINT_VER = '2013'>(listName: K, sharepoint_ver?: V): {
-        create: (data: ListData) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        get: (options?: Options<T['LISTS'][K], V>) => Promise<{
-            data: (T["LISTS"][K] & Partial<import("../types").SPItem<V>>)[];
-            meta: {
-                url: URL;
-            };
-        }>;
-        update: (id: ItemID, data: ListData, digest?: string) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        delete: (id: ItemID) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        createFile: (props: CreateFileProps) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        fields: (options?: Field_Options<T['LISTS'][K], V>) => {
-            get: () => Promise<any>;
-        };
-    };
-    folders: {
-        get: () => void;
-    };
-    folder(folderName?: string | string[]): {
-        get: (options?: Folder_Options<any>) => Promise<{
-            data: any;
-            meta: {
-                url: URL;
-            };
-        }>;
-    };
-    users(options?: Options<any>): {
-        get: () => Promise<{
-            data: any[];
-            meta: {
-                url: URL;
-            };
-        }>;
-    };
-    email: {
-        send: (props: EmailProps) => Promise<import("axios").AxiosResponse<{
-            d: {
-                SendEmail: null;
-            };
-        }, any, {}>>;
-    };
-    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>;
-        };
-    };
-}
-export default HTTPSharePointRequests;
+import { CreateAxiosDefaults as AxiosConfig } from 'axios';
+import { CreateFileProps, CurrentUser, EmailProps, Field_Options, Folder_Options, UploadFileProps, IListName, ItemID, ListData, Options, PersonField, SHAREPOINT_VER, UserPermision, UserProfile } from '../types';
+declare class HTTPSharePointRequests<T extends {
+    LISTS: Record<string, unknown>;
+    FOLDERS?: Record<string, unknown>;
+}> {
+    private baseURL;
+    private endpoint;
+    private listName;
+    private instance;
+    private sharepointVersion;
+    private listItemEntityTypeFullName?;
+    constructor(baseURL: string, config?: AxiosConfig);
+    private getContext;
+    private resolveListItemEntityTypeFullName;
+    /**
+     * @deprecated Use `from` instead.
+     */
+    list(listName: IListName<T>): this;
+    readonly lists: {
+        get: () => Promise<{
+            data: Partial<import("../types").SPItem2013>[];
+            meta: {
+                url: URL;
+            };
+        }>;
+    };
+    getDigest(): Promise<string>;
+    from<K extends Extract<keyof T['LISTS'], string>, V extends SHAREPOINT_VER = '2013'>(listName: K, sharepoint_ver?: V): {
+        create: (data: ListData) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+        get: (options?: Options<T["LISTS"][K], V>) => Promise<{
+            data: (T["LISTS"][K] & Partial<import("../types").SPItem<V>>)[];
+            meta: {
+                url: URL;
+            };
+        }>;
+        update: (id: ItemID, data: ListData, digest?: string) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+        delete: (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, {}>>;
+        fields: (options?: Field_Options<T["LISTS"][K], V>) => {
+            get: () => Promise<any>;
+        };
+    };
+    folders: {
+        get: () => void;
+    };
+    folder(folderName?: string | string[]): {
+        get: (options?: Folder_Options<any>) => Promise<{
+            data: any;
+            meta: {
+                url: URL;
+            };
+        }>;
+    };
+    users(options?: Options<any>): {
+        get: () => Promise<{
+            data: any[];
+            meta: {
+                url: URL;
+            };
+        }>;
+    };
+    email: {
+        send: (props: EmailProps) => Promise<import("axios").AxiosResponse<{
+            d: {
+                SendEmail: null;
+            };
+        }, any, {}>>;
+    };
+    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>;
+        };
+    };
+}
+export default HTTPSharePointRequests;

package/dist/root/instance.d.ts

@@ -1,3 +1,3 @@
-import { CreateAxiosDefaults as AxiosConfig } from 'axios';
-export declare const instance: (baseURL: string, config?: AxiosConfig) => import("axios").AxiosInstance;
-export default instance;
+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,9 +1,11 @@
-import type { AxiosInstance } from 'axios';
-import type { SHAREPOINT_VER } from '../../types';
-export interface RequestContext<V extends SHAREPOINT_VER = '2013'> {
-    instance: AxiosInstance;
-    baseURL: string;
-    endpoint: string;
-    listName: string;
-    sharepointVersion: V;
-}
+import type { AxiosInstance } from 'axios';
+import type { 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 +1,2 @@
-import type { AxiosInstance } from 'axios';
-export declare function fetchDigest(instance: AxiosInstance, baseURL: string): Promise<string>;
+import type { AxiosInstance } from 'axios';
+export declare function fetchDigest(instance: AxiosInstance, baseURL: string): Promise<string>;

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

@@ -1,10 +1,10 @@
-import type { AxiosResponse } from 'axios';
-import type { EmailProps } from '../../types';
-import type { RequestContext } from './context';
-declare type SendEmailResponse = AxiosResponse<{
-    d: {
-        SendEmail: null;
-    };
-}>;
-export declare function sendEmail(context: RequestContext, { From, To, Subject, Body }: EmailProps): Promise<SendEmailResponse>;
-export {};
+import type { AxiosResponse } from 'axios';
+import type { EmailProps } from '../../types';
+import type { 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 +1,3 @@
-import type { CreateFileProps, SHAREPOINT_VER } from '../../../types';
-import type { RequestContext } from '../context';
-export declare function createAttachment<V extends SHAREPOINT_VER = '2013'>(context: RequestContext<V>, { file, itemId }: CreateFileProps): Promise<import("axios").AxiosResponse<any, any, {}>>;
+import type { CreateFileProps, SHAREPOINT_VER } from '../../../types';
+import type { 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 +1,3 @@
-import type { ListData, SHAREPOINT_VER } from '../../../types';
-import type { RequestContext } from '../context';
-export declare function createListItem<V extends SHAREPOINT_VER = '2013'>(context: RequestContext<V>, listData: ListData): Promise<import("axios").AxiosResponse<any, any, {}>>;
+import type { ListData, SHAREPOINT_VER } from '../../../types';
+import type { RequestContext } from '../context';
+export declare function createListItem<V extends SHAREPOINT_VER = '2013'>(context: RequestContext<V>, listData: ListData): Promise<import("axios").AxiosResponse<any, any, {}>>;

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

@@ -1,3 +1,3 @@
-import type { SHAREPOINT_VER } from '../../../types';
-import type { RequestContext } from '../context';
-export declare function deleteItem<V extends SHAREPOINT_VER = '2013'>(context: RequestContext<V>, id: number | string): Promise<import("axios").AxiosResponse<any, any, {}>>;
+import type { SHAREPOINT_VER } from '../../../types';
+import type { 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 +1,8 @@
-import type { Folder_Options, SHAREPOINT_VER } from '../../../types';
-import type { 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;
-    };
-}>;
+import type { Folder_Options, SHAREPOINT_VER } from '../../../types';
+import type { 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 +1,8 @@
-import type { Options, SPItem, SHAREPOINT_VER } from '../../../types';
-import type { 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>>)[];
-    meta: {
-        url: URL;
-    };
-}>;
+import type { Options, SPItem, SHAREPOINT_VER } from '../../../types';
+import type { 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>>)[];
+    meta: {
+        url: URL;
+    };
+}>;

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

@@ -1,3 +1,3 @@
-import type { AxiosInstance } from 'axios';
-import type { 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>;
+import type { AxiosInstance } from 'axios';
+import type { 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,7 +1,8 @@
-export { createListItem } from './createListItem';
-export { createAttachment } from './createAttachment';
-export { deleteItem } from './deleteItem';
-export { getFiles } from './getFiles';
-export { getListItems } from './getListItems';
-export { getOnly } from './getOnly';
-export { updateListItem } from './updateListItem';
+export { createListItem } from './createListItem';
+export { createAttachment } from './createAttachment';
+export { deleteItem } from './deleteItem';
+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/updateListItem.d.ts

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

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

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

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

@@ -1,5 +1,5 @@
-import type { Folder_Options, Options, SHAREPOINT_VER } from '../../types';
-declare 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 {};
+import type { 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/userRequests.d.ts

@@ -1,15 +1,15 @@
-import type { AxiosInstance } from 'axios';
-import type { PersonField, UserPermision, UserProfile } from '../../types';
-import type { RequestContext } from './context';
-declare 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 {};
+import type { AxiosInstance } from 'axios';
+import type { PersonField, UserPermision, UserProfile } from '../../types';
+import type { 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 {};