@jimmybjorklund/sharepoint-api 1.0.1

package/LICENSE.md

@@ -0,0 +1,11 @@
+The MIT License (MIT)
+=====================
+
+Copyright (c) 2024 sharepoint-client contributors
+----------------------------------------------
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,129 @@
+sharepoint-api
+====
+
+[![NPM](https://nodei.co/npm/@jimmybjorklund/sharepoint-api.png)](https://nodei.co/npm/@jimmybjorklund/sharepoint-api/)
+
+## Introduction
+This client makes it easier to upload/download and list files on your Microsoft SharePoint account.
+
+It uses the Microsoft Graph api to handle the communication and you need to create an 
+client access token for this api for this library to work.
+
+## Installation
+
+```
+$ npm install @jimmybjorklund/sharepoint-client
+```
+
+## Create access.
+
+### 1. First we need to create a app that is allowed to access the files. 
+   
+   Navigate to: https://entra.microsoft.com/
+
+   Once you have logged in navigate in the menu.
+
+        Application->App registrations.
+
+   On this page select 
+
+        + New registration.
+
+   Give the integration app a good name and select single tenant and press Register.
+
+   You should now be presented with the Application overview, on this page search for
+   Application (client) ID <b>save this id for later as clientId.</b>
+
+   On this page you should also be able to find the Directory (tenant) ID, <b>save this as
+   tenantId for later.</b>
+
+
+### 2. Create a client secret this is done by navigating to Certificates & secrets under you app view.
+
+   On this page click
+
+        + New client secret 
+
+   Enter a good description and max lifetime of you tokens and press Add.
+
+   In the list of secrets you should now see the Value of your secret key, <b>save this into 
+   a variable called clientSecret.</b> NOTE: Do this directly as it will only be visible once.
+   If you fail to do this you can remove it an recreated it to se a new value.
+
+### 3. Setup Api permissions by going to API permissions.
+   
+   On this page click.
+
+        + Add a permission
+
+   You should select the api that say <b>Microsoft Graph.</b>
+   You will be presented with two options delegated access or application.
+    <b>Select application permissions.</b>
+
+   You need to select:
+
+        Directory.ReadWrite.All
+        Files.ReadWrite.All
+  
+### Congratulations
+You should now have a clientId and secret that will give you access.
+
+
+
+## Sample
+  This is a simple example of how to use the Microsoft Graph API to upload a file to a SharePoint site.
+  
+  ```ts
+//This is the name of the tenant in SharePoint, normally first part of the url.
+//sample: myName.sharepoint.com  
+const tenantName: "myName";
+// From App Overview page.
+const tenantId: "00000000-0000-0000-0000-000000000000";
+  
+// This is the name of the site (group in teams) in SharePoint.
+const siteName: "MyGroup";
+   
+// This is the id and secret of the app you created in Azure AD.
+const clientId: "00000000-0000-0000-0000-000000000000";
+const clientSecret: "0000000000000000000000000000000000000000";
+  
+const client = new SharepointApi({
+                                   tenantId,
+                                   tenantName,
+                                   siteName,
+                                   clientId,
+                                   clientSecret
+                                  });
+// Get a Azure AD login token.                                    
+const token = await client.login();
+if (token === undefined) {
+    console.log("Error getting token");
+    return;
+}
+
+// Fetch the site to get the siteId.
+const site = await azure.getSite(token);
+if (site === undefined) {
+    console.log("Error getting site");
+    return;
+}
+const siteId = client.getSiteId(site);
+const driveName = "Dokument"; // Folder name in SharePoint.
+
+// Get the driver to find the correct driverId.
+const driver = await client.getDrive(token, siteId, driveName);
+if (driver === undefined) {
+    console.log("Error getting drive");
+    return;
+}
+
+const path = "/TestUploadFiles";
+const fileName = "test.txt";
+// Upload files.
+const res = await client.upload(token, driver.id, path, fileName, "text/plain");
+console.log("Upload response", res);
+```
+
+## LICENSE
+
+MIT, see LICENSE.md file.

package/dist/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SharepointApi = void 0;
+const sharepoint_api_1 = require("./sharepoint-api");
+Object.defineProperty(exports, "SharepointApi", { enumerable: true, get: function () { return sharepoint_api_1.SharepointApi; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qDAAiD;AACxC,8FADA,8BAAa,OACA"}

package/dist/sharepoint-api.js

@@ -0,0 +1,195 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SharepointApi = void 0;
+const axios_1 = require("axios");
+const qs = require("qs");
+class SharepointApi {
+    tenantId;
+    tenantName;
+    siteName;
+    clientId;
+    clientSecret;
+    constructor(config) {
+        this.tenantId = config.tenantId;
+        this.tenantName = config.tenantName;
+        this.siteName = config.siteName;
+        this.clientId = config.clientId;
+        this.clientSecret = config.clientSecret;
+    }
+    /**
+     * Get a token from Azure AD.
+     * @returns The token or undefined if an error occurred.
+     */
+    login = async () => {
+        const tokenEndpoint = `https://login.microsoftonline.com/${this.tenantId}/oauth2/v2.0/token`;
+        const options = {
+            headers: {
+                "Content-Type": `application/x-www-form-urlencoded`,
+            },
+        };
+        const data = qs.stringify({
+            grant_type: "client_credentials",
+            client_id: this.clientId,
+            client_secret: this.clientSecret,
+            scope: "https://graph.microsoft.com/.default",
+        });
+        const tokenResponse = await axios_1.default
+            .post(tokenEndpoint, data, options)
+            .then((response) => {
+            if (response.status !== 200) {
+                console.log("Error getting token", response);
+                return undefined;
+            }
+            return response.data;
+        })
+            .catch((error) => {
+            console.log("Error getting token", error);
+            return undefined;
+        });
+        return tokenResponse;
+    };
+    /**
+     * Get a specific site from SharePoint.
+     * @param token - The token from the login method.
+     * @returns The site or undefined if an error occurred.
+     */
+    getSite = async (token) => {
+        const url = `https://graph.microsoft.com/v1.0/sites/${this.tenantName}.sharepoint.com:/sites/${this.siteName}`;
+        const options = {
+            headers: {
+                Authorization: `Bearer ${token.access_token}`,
+            },
+        };
+        return axios_1.default
+            .get(url, options)
+            .then((response) => {
+            return response.data;
+        })
+            .catch((error) => {
+            console.log("Error getting site", error);
+        });
+    };
+    /**
+     * Get all drives in a site.
+     * @param token - The token from the login method.
+     * @param siteId - The id of the site.
+     * @returns The drives or undefined if an error occurred.
+     */
+    getDrives = async (token, siteId) => {
+        const url = `https://graph.microsoft.com/v1.0/sites/${siteId}/Drives`;
+        const options = {
+            headers: {
+                Authorization: `Bearer ${token.access_token}`,
+            },
+        };
+        return axios_1.default
+            .get(url, options)
+            .then((response) => {
+            return response.data?.value;
+        })
+            .catch((error) => {
+            console.log("Error getting drives", error);
+        });
+    };
+    /**
+     * Get a specific drive from a site.
+     * @param token - The token from the login method.
+     * @param siteId - The id of the site.
+     * @param driveName - The name of the drive to get.
+     * @returns The drive or undefined if an error occurred.
+     */
+    getDrive = async (token, siteId, driveName) => {
+        const drives = await this.getDrives(token, siteId);
+        if (drives === undefined) {
+            console.log("Error getting drives");
+            return undefined;
+        }
+        const driver = drives.find((drive) => {
+            return drive.name === driveName;
+        });
+        return driver;
+    };
+    /**
+     * Get items (files, directories etc) in a drive.
+     * @param token - The token from the login method.
+     * @param driverId - The id of the drive to get items from.
+     * @param path - The path to the items in from.
+     * @returns The items or undefined if an error occurred.
+     */
+    getItems = async (token, driverId, path) => {
+        const url = `https://graph.microsoft.com/v1.0/Drives/${driverId}/root:/${path}:/Children.`;
+        const options = {
+            headers: {
+                Authorization: `Bearer ${token.access_token}`,
+            },
+        };
+        return axios_1.default
+            .get(url, options)
+            .then((response) => {
+            return response.data?.value;
+        })
+            .catch((error) => {
+            console.log("Error getting items", error);
+            return undefined;
+        });
+    };
+    /**
+     * Download a file from a SharePoint site.
+     * @param token - The token from the login method.
+     * @param driverId - The id of the drive to download from.
+     * @param path - The path to the file in the drive.
+     * @returns The file content or undefined if an error occurred.
+     */
+    downloadItem = async (token, driverId, path) => {
+        const url = `https://graph.microsoft.com/v1.0/Drives/${driverId}/root:/${path}:/content`;
+        const options = {
+            headers: {
+                Authorization: `Bearer ${token.access_token}`,
+            },
+        };
+        return axios_1.default
+            .get(url, options)
+            .then((response) => {
+            return response.data;
+        })
+            .catch((error) => {
+            console.log("Error getting item", error);
+            return undefined;
+        });
+    };
+    /**
+     * Upload or update a file in a SharePoint site.
+     * @param token - The token from the login method.
+     * @param driverId - The id of the drive to upload to.
+     * @param path - The path to the file in the drive.
+     * @param fileName - The name of the target file.
+     * @param contentType - The content type of the file.
+     * @param data - The file content as a buffer.
+     * @returns The uploaded item or undefined if an error occurred.
+     */
+    upload = async (token, driverId, path, fileName, contentType, data) => {
+        const url = `https://graph.microsoft.com/v1.0//drives/${driverId}/root:${path}/${fileName}:/content`;
+        const options = {
+            headers: {
+                "Content-Type": contentType,
+                Authorization: `Bearer ${token.access_token}`,
+            },
+        };
+        //const binaryContent = new Blob(["Hello, World!"], { type: contentType });
+        return axios_1.default
+            .put(url, data, options)
+            .then((response) => {
+            console.log("Upload response", response.status, response.statusText);
+            return response.data;
+        })
+            .catch((error) => {
+            console.log("Error uploading", error.response);
+            return undefined;
+        });
+    };
+    getSiteId = (site) => {
+        return site.id.split(",")[1];
+    };
+}
+exports.SharepointApi = SharepointApi;
+//# sourceMappingURL=sharepoint-api.js.map

package/dist/sharepoint-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharepoint-api.js","sourceRoot":"","sources":["../src/sharepoint-api.ts"],"names":[],"mappings":";;;AAAA,iCAA0B;AAC1B,yBAAyB;AAEzB,MAAa,aAAa;IAChB,QAAQ,CAAS;IACjB,UAAU,CAAS;IACnB,QAAQ,CAAS;IACjB,QAAQ,CAAS;IACjB,YAAY,CAAS;IAC7B,YAAY,MAA0G;QACpH,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QACpC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACI,KAAK,GAAG,KAAK,IAAsC,EAAE;QAC1D,MAAM,aAAa,GAAG,qCAAqC,IAAI,CAAC,QAAQ,oBAAoB,CAAC;QAC7F,MAAM,OAAO,GAAG;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,mCAAmC;aACpD;SACF,CAAC;QACF,MAAM,IAAI,GAAG,EAAE,CAAC,SAAS,CAAC;YACxB,UAAU,EAAE,oBAAoB;YAChC,SAAS,EAAE,IAAI,CAAC,QAAQ;YACxB,aAAa,EAAE,IAAI,CAAC,YAAY;YAChC,KAAK,EAAE,sCAAsC;SAC9C,CAAC,CAAC;QACH,MAAM,aAAa,GAAG,MAAM,eAAK;aAC9B,IAAI,CAAC,aAAa,EAAE,IAAI,EAAE,OAAO,CAAC;aAClC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjB,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;gBAC3B,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAC;gBAC7C,OAAO,SAAS,CAAC;aAClB;YACD,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;YAC1C,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;QAEL,OAAO,aAAa,CAAC;IACvB,CAAC,CAAC;IAEF;;;;OAIG;IACI,OAAO,GAAG,KAAK,EAAE,KAAkB,EAA2C,EAAE;QACrF,MAAM,GAAG,GAAG,0CAA0C,IAAI,CAAC,UAAU,0BAA0B,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC/G,MAAM,OAAO,GAAG;YACd,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,KAAK,CAAC,YAAY,EAAE;aAC9C;SACF,CAAC;QACF,OAAO,eAAK;aACT,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC;aACjB,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjB,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,KAAK,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;IAEF;;;;;OAKG;IACI,SAAS,GAAG,KAAK,EAAE,KAAkB,EAAE,MAAc,EAA8C,EAAE;QAC1G,MAAM,GAAG,GAAG,0CAA0C,MAAM,SAAS,CAAC;QACtE,MAAM,OAAO,GAAG;YACd,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,KAAK,CAAC,YAAY,EAAE;aAC9C;SACF,CAAC;QACF,OAAO,eAAK;aACT,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC;aACjB,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjB,OAAO,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;QAC9B,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,KAAK,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;IAEF;;;;;;OAMG;IACI,QAAQ,GAAG,KAAK,EAAE,KAAkB,EAAE,MAAc,EAAE,SAAiB,EAA4C,EAAE;QAC1H,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACnD,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;YACpC,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;YACnC,OAAO,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC;QAClC,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IAEF;;;;;;OAMG;IACI,QAAQ,GAAG,KAAK,EAAE,KAAkB,EAAE,QAAgB,EAAE,IAAY,EAA6C,EAAE;QACxH,MAAM,GAAG,GAAG,2CAA2C,QAAQ,UAAU,IAAI,aAAa,CAAC;QAC3F,MAAM,OAAO,GAAG;YACd,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,KAAK,CAAC,YAAY,EAAE;aAC9C;SACF,CAAC;QACF,OAAO,eAAK;aACT,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC;aACjB,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjB,OAAO,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;QAC9B,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;YAC1C,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;IAEF;;;;;;OAMG;IACI,YAAY,GAAG,KAAK,EAAE,KAAkB,EAAE,QAAgB,EAAE,IAAY,EAA4B,EAAE;QAC3G,MAAM,GAAG,GAAG,2CAA2C,QAAQ,UAAU,IAAI,WAAW,CAAC;QACzF,MAAM,OAAO,GAAG;YACd,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,KAAK,CAAC,YAAY,EAAE;aAC9C;SACF,CAAC;QACF,OAAO,eAAK;aACT,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC;aACjB,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjB,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,KAAK,CAAC,CAAC;YACzC,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;IAEF;;;;;;;;;OASG;IACI,MAAM,GAAG,KAAK,EAAE,KAAkB,EAAE,QAAgB,EAAE,IAAY,EAAE,QAAgB,EAAE,WAAmB,EAAE,IAAY,EAA2C,EAAE;QACzK,MAAM,GAAG,GAAG,4CAA4C,QAAQ,SAAS,IAAI,IAAI,QAAQ,WAAW,CAAC;QACrG,MAAM,OAAO,GAAG;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,WAAW;gBAC3B,aAAa,EAAE,UAAU,KAAK,CAAC,YAAY,EAAE;aAC9C;SACF,CAAC;QACF,2EAA2E;QAC3E,OAAO,eAAK;aACT,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC;aACvB,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjB,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;YACrE,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;YAC/C,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;IAEK,SAAS,GAAG,CAAC,IAAwB,EAAU,EAAE;QACtD,OAAO,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/B,CAAC,CAAC;CACH;AApMD,sCAoMC"}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@jimmybjorklund/sharepoint-api",
+  "version": "1.0.1",
+  "description": "Lets you easily access and update files on sharepoint",
+  "main": "dist/index.js",
+  "types": "dist/index.d.js",
+  "prepublish": "npm run build",
+  "scripts": {
+    "build": "tsc -b",
+    "start": "ts-node tests/index.ts",
+    "prettier": "prettier --write src/"
+  },
+  "author": "Jimmy Björklund",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^1.6.7",
+    "qs": "^6.11.2"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.16",
+    "@types/qs": "^6.9.11",
+    "prettier": "^3.2.5",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.4"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JimmyBjorklund/sharepoint-api.git"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "sharepoint",
+    "sharepoint-api",
+    "azure",
+    "office365"
+  ]
+}