filemail-sdk 10.3.0 → 10.4.0

package/package.json

@@ -1,78 +1,79 @@
-{
-    "name": "filemail-sdk",
-    "version": "10.3.0",
-    "description": "Library for transferring files to and from Filemail.com",
-    "author": "Filemail AS",
-    "license": "BSD-3-Clause",
-    "main": "dist/src/index.node.js",
-    "module": "dist/src/index.node.js",
-    "browser": "dist/src/index.web.js",
-    "exports": {
-        ".": {
-            "browser": "./dist/src/index.web.js",
-            "import": "./dist/src/index.node.js",
-            "require": "./dist/src/index.node.js"
-        }
-    },
-    "type": "module",
-    "files": [
-        "dist/src"
-    ],
-    "publishConfig": {
-        "registry": "https://registry.npmjs.org/"
-    },
-    "scripts": {
-        "test": "yarn build && ava",
-        "test:ci": "ava --tap",
-        "eslint": "eslint src test",
-        "eslint:ci": "yarn eslint",
-        "watch": "tsc -w",
-        "clean": "del-cli --force dist",
-        "build": "yarn clean && eslint && tsc",
-        "build:ci": "yarn build"
-    },
-    "devDependencies": {
-        "@eslint/eslintrc": "^3.2.0",
-        "@eslint/js": "^9.17.0",
-        "@tsconfig/node20": "^20.1.4",
-        "@types/lodash.throttle": "^4.1.7",
-        "@types/mock-fs": "^4.13.1",
-        "@types/sinon": "^21.0.0",
-        "@types/spark-md5": "^3.0.5",
-        "@types/uuid": "^11.0.0",
-        "@typescript-eslint/eslint-plugin": "^8.0.0",
-        "@typescript-eslint/parser": "^8.0.0",
-        "ava": "^6.0.0",
-        "console-gui-tools": "^3.0.2",
-        "del-cli": "^7.0.0",
-        "eslint": "^9.0.0",
-        "eslint-config-airbnb-base": "^15.0.0",
-        "eslint-plugin-import": "^2.26.0",
-        "fetch-mock": "^12.5.4",
-        "globals": "^16.5.0",
-        "mock-fs": "^5.5.0",
-        "nock": "^14.0.10",
-        "sinon": "^21.0.1",
-        "typescript": "^5.0.4"
-    },
-    "dependencies": {
-        "abortable-sleep": "^1.0.0",
-        "aes-ctr-concurrent": "^1.0.0",
-        "async-mutex": "^0.5.0",
-        "axios": "^1.8.4",
-        "axios-retry": "^4.5.0",
-        "got": "^14.0.0",
-        "lodash.throttle": "^4.1.1",
-        "spark-md5": "^3.0.2",
-        "tap-tc": "^4.4.4",
-        "uuid": "^13.0.0"
-    },
-    "ava": {
-        "files": [
-            "dist/test/**/*.spec.js"
-        ]
-    },
-    "engines": {
-        "node": "<=20.9.0"
-    }
-}
+{
+    "name": "filemail-sdk",
+    "version": "10.4.0",
+    "description": "Library for transferring files to and from Filemail.com",
+    "author": "Filemail AS",
+    "license": "BSD-3-Clause",
+    "main": "dist/src/index.node.js",
+    "module": "dist/src/index.node.js",
+    "browser": "dist/src/index.web.js",
+    "exports": {
+        ".": {
+            "browser": "./dist/src/index.web.js",
+            "import": "./dist/src/index.node.js",
+            "require": "./dist/src/index.node.js"
+        }
+    },
+    "type": "module",
+    "files": [
+        "dist/src"
+    ],
+    "publishConfig": {
+        "registry": "https://registry.npmjs.org/"
+    },
+    "scripts": {
+        "clean-repo": "find . \\( -name '.turbo' -o -name 'node_modules' -o -name '.vite' -o -name 'dist' -o -name 'dist-web' -o -name 'out' -o -name '.codex-tmp' -o -name '.env' \\) -prune -exec rm -rf {} +",
+        "test": "yarn build && ava",
+        "test:ci": "ava --tap",
+        "eslint": "eslint src test",
+        "eslint:ci": "yarn eslint",
+        "watch": "tsc -w",
+        "clean": "del-cli --force dist",
+        "build": "yarn clean && eslint && tsc",
+        "build:ci": "yarn build"
+    },
+    "devDependencies": {
+        "@eslint/eslintrc": "^3.2.0",
+        "@eslint/js": "^9.17.0",
+        "@tsconfig/node20": "^20.1.4",
+        "@types/lodash.throttle": "^4.1.7",
+        "@types/mock-fs": "^4.13.1",
+        "@types/sinon": "^21.0.0",
+        "@types/spark-md5": "^3.0.5",
+        "@types/uuid": "^11.0.0",
+        "@typescript-eslint/eslint-plugin": "^8.0.0",
+        "@typescript-eslint/parser": "^8.0.0",
+        "ava": "^6.0.0",
+        "console-gui-tools": "^3.0.2",
+        "del-cli": "^7.0.0",
+        "eslint": "^9.0.0",
+        "eslint-config-airbnb-base": "^15.0.0",
+        "eslint-plugin-import": "^2.26.0",
+        "fetch-mock": "^12.5.4",
+        "globals": "^16.5.0",
+        "mock-fs": "^5.5.0",
+        "nock": "^14.0.10",
+        "sinon": "^21.0.1",
+        "typescript": "^5.0.4"
+    },
+    "dependencies": {
+        "abortable-sleep": "^1.0.0",
+        "aes-ctr-concurrent": "^1.0.0",
+        "async-mutex": "^0.5.0",
+        "axios": "^1.8.4",
+        "axios-retry": "^4.5.0",
+        "got": "^14.0.0",
+        "lodash.throttle": "^4.1.1",
+        "spark-md5": "^3.0.2",
+        "tap-tc": "^4.4.4",
+        "uuid": "^13.0.0"
+    },
+    "ava": {
+        "files": [
+            "dist/test/**/*.spec.js"
+        ]
+    },
+    "engines": {
+        "node": "<=20.9.0"
+    }
+}

package/readme.md

@@ -1,19 +1,27 @@
-# Filemail SDK
-
-The Filemail SDK is a simple and efficient npm package for sending and downloading files through [Filemail.com](https://filemail.com), a secure platform for transferring large files.
-
-## Installation
-
-```bash
-npm install filemail-sdk
-```
-
-## Features
-
-* File Upload: Quickly and securely upload files to Filemail.com.
-
-* File Download: Easily download files previously uploaded to Filemail.com.
-
-The Filemail SDK is designed to provide a straightforward, reliable way to integrate file transfer capabilities into your applications. With this tool, you can leverage Filemail’s file-sharing features without hassle.
-
-For more information, visit [Filemail.com](https://filemail.com).
+# Filemail SDK
+
+The Filemail SDK is a simple and efficient npm package for sending and downloading files through [Filemail.com](https://filemail.com), a secure platform for transferring large files.
+
+## Installation
+
+```bash
+npm install filemail-sdk
+```
+
+## Features
+
+* File Upload: Quickly and securely upload files to Filemail.com.
+
+* File Download: Easily download files previously uploaded to Filemail.com.
+
+The Filemail SDK is designed to provide a straightforward, reliable way to integrate file transfer capabilities into your applications. With this tool, you can leverage Filemail’s file-sharing features without hassle.
+
+## Upload data region
+
+Set `dataRegion` in `TransferUploadInfo` to `eu`, `us`, or `no` to choose where a transfer is stored. Use the regions returned by `GET /user/me` in `dataRegionOptions`, and only offer the choice when `canSetDataRegion.state` is `active`.
+
+Set `dataRegion: "auto"` to explicitly request automatic selection, even if the sender has a saved default. Omit the field to use that default. Automatic selection still follows the company's data residency policy.
+
+For incoming transfers (portals, file requests, or company uploads), omit `dataRegion`; the backend applies the portal's setting.
+
+For more information, visit [Filemail.com](https://filemail.com).