HTTP SharePoint Requests

This package is a TypeScript library for interacting with SharePoint REST APIs. It provides a structured and flexible approach to perform CRUD operations, handle user information, manage files, and retrieve metadata from SharePoint lists.

Installation

Install the package using npm:

npm install sharepoint-requests

Usage

Create a SharePoint Request Instance

import createBase from 'sharepoint-requests';

const sharepoint = createBase().create({
  baseURL: 'https://your-sharepoint-site.com',
});

Basic Methods

Retrieve List Fields

const fields = await sharepoint.field('ListName', 'FieldName');
console.log(fields);

Access Lists

const lists = await sharepoint.lists().get();
console.log(lists);

Access Items in a List

const { data, meta } = await sharepoint.from('ListName').get({ limit: 10 });
console.log({ data, meta });

Create a New Item in a List

const newItem = await sharepoint.from('ListName').create({
  Title: 'New Item',
  Description: 'This is a new item.',
});
console.log(newItem);

Update an Item in a List

const updatedItem = await sharepoint.from('ListName').update(1, {
  Title: 'Updated Title',
});
console.log(updatedItem);

Delete an Item in a List

await sharepoint.from('ListName').delete(1);
console.log('Item deleted successfully');

Advanced Features

Upload Files

const file = new File(['content'], 'example.txt');
await sharepoint.from('ListName').createFile({ file, itemId: 1 });
console.log('File uploaded successfully');

Send Emails

await sharepoint.email(
  '[email protected]',
  ['[email protected]'],
  'Subject of Email',
  'Body of the email content.'
);
console.log('Email sent successfully');

Retrieve Current User Information

const currentUser = await sharepoint.getCurrentUser();
console.log(currentUser);

Retrieve User Properties

const userProfile = await sharepoint.currentUserProperties();
console.log(userProfile);

Authentication

Ensure that the requests are authenticated by passing the appropriate cookies or tokens for your SharePoint environment.

Error Handling

Handle errors using try-catch blocks:

try {
  const lists = await sharepoint.lists().get();
  console.log(lists);
} catch (error) {
  console.error('An error occurred:', error);
}

TypeScript Support

The package is fully typed, enabling autocompletion and type safety for all methods.

API Reference

Constructor

createBase<T>()

• Creates a base instance for SharePoint requests.
• Params:
  • baseURL (string): The base URL of your SharePoint site.

Methods

Lists

• lists().get() - Retrieve all lists in the SharePoint site.
• from(listName) - Access specific list operations.

Items

• create(data) - Create a new list item.
• get(options) - Retrieve list items with filters, sorting, and limits.
• update(id, data) - Update an existing list item.
• delete(id) - Delete a list item.

Users

• getCurrentUser() - Retrieve the current user information.
• userGetId(userName) - Get the ID of a user by username.

Files

• createFile({ file, itemId }) - Upload a file to a list item.

Development

Feel free to contribute or report issues. Pull requests are welcome.

License

MIT License. See LICENSE for details.