files.com 1.2.180 → 1.2.182

package/README.md

@@ -546,126 +546,17 @@ Error
 |     `SiteConfiguration_TrialLockedError`|  `SiteConfigurationError` |
 |     `SiteConfiguration_UserRequestsEnabledRequiredError`|  `SiteConfigurationError` |
 
-## Examples
+## Case Sensitivity
 
-### Upload
+The Files.com API compares files and paths in a case-insensitive manner.
+ For related documentation see [Case Sensitivity Documentation](https://www.files.com/docs/files-and-folders/file-system-semantics/case-sensitivity).
 
-#### Upload a File
+The `pathNormalizer.same` function in the Files.com SDK is designed to help you determine if two paths on
+your native file system would be considered the same on Files.com. This is particularly important
+when handling errors related to duplicate file names and when developing tools for folder
+synchronization.
 
-```javascript
-import File from 'files.com/lib/models/File.js';
-import { isBrowser } from 'files.com/lib/utils.js';
-
-// uploading raw file data
-await File.uploadData(destinationFileName, data);
-
-// upload readable stream
-await File.uploadStream(destinationFileName, readableStream)
-
-// uploading a file on disk (not available in browser)
-if (!isBrowser()) {
-  await File.uploadFile(destinationFileName, sourceFilePath);
-}
-```
-
-#### Create a Folder
-
-```javascript
-import Folder from 'files.com/lib/models/Folder.js';
-
-await Folder.create('path/to/folder/to/be/created', {
-  mkdir_parents: true,
-});
-```
-
-### Download
-
-#### Get a Downloadable File Object by Path
-
-```javascript
-import File from 'files.com/lib/models/File.js';
-
-const foundFile = await File.find(remoteFilePath);
-const downloadableFile = await foundFile.download();
-```
-
-#### Download a File (not available in browser)
-
-```javascript
-import { isBrowser } from 'files.com/lib/utils.js';
-
-if (!isBrowser()) {
-  // download to a file on disk
-  await downloadableFile.downloadToFile(localFilePath);
-
-  // download to a writable stream
-  await downloadableFile.downloadToStream(stream);
-
-  // download in memory and return as a UTF-8 string
-  const textContent = await downloadableFile.downloadToString();
-}
-```
-
-### List
-
-#### List Folder Contents
-
-```javascript
-import Folder from 'files.com/lib/models/Folder.js';
-
-const items = await Folder.listFor('remote/path/to/folder/');
-for (const item of items) {
-  console.log(item.path);
-}
-```
-
-### Copy
-
-The copy method works for both files and folders.
-
-```javascript
-import File from 'files.com/lib/models/File.js';
-
-const file = new File({ path: 'source/path' });
-await file.copy({ destination: 'destination/path' });
-```
-
-### Move
-
-The move method works for both files and folders.
-
-```javascript
-import File from 'files.com/lib/models/File.js';
-
-const file = new File({ path: 'source/path' });
-await file.move({ destination: 'destination/path' });
-```
-
-### Delete
-
-The delete method works for both files and folders.
-
-```javascript
-import File from 'files.com/lib/models/File.js';
-
-const file = new File({ path: 'path/to/file/or/folder' });
-await file.delete();
-```
-
-In case the folder is not empty, you can use the `recursive` argument:
-
-```javascript
-import File from 'files.com/lib/models/File.js';
-
-const folder = new File({ path: 'path/to/folder' });
-await folder.delete({ recursive: true });
-```
-
-### Comparing Case-Insensitive Files and Paths
-
-For related documentation see [Case Sensitivity Documentation](https://www.files.com/docs/files-and-folders/file-system-semantics/case-sensitivity).
-
-```javascript
+```javascript title="Compare Case-Insensitive Files and Paths"
 import { pathNormalizer } from 'files.com/lib/utils.js';
 
 if (pathNormalizer.same('Fïłèńämê.Txt', 'filename.txt')) {

package/_VERSION

@@ -1 +1 @@
-1.2.180
+1.2.182

package/lib/Files.js

@@ -11,7 +11,7 @@ var endpointPrefix = '/api/rest/v1';
 var apiKey;
 var baseUrl = 'https://app.files.com';
 var sessionId = null;
-var version = '1.2.180';
+var version = '1.2.182';
 var userAgent = "Files.com JavaScript SDK v".concat(version);
 var logLevel = _Logger.LogLevel.INFO;
 var debugRequest = false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "files.com",
-  "version": "1.2.180",
+  "version": "1.2.182",
   "description": "Files.com SDK for JavaScript",
   "keywords": [
     "files.com",

package/src/Files.js

@@ -5,7 +5,7 @@ const endpointPrefix = '/api/rest/v1'
 let apiKey
 let baseUrl = 'https://app.files.com'
 let sessionId = null
-const version = '1.2.180'
+const version = '1.2.182'
 let userAgent = `Files.com JavaScript SDK v${version}`
 
 let logLevel = LogLevel.INFO