files.com 1.2.234 → 1.2.236

package/README.md

@@ -420,6 +420,22 @@ try {
 }
 ```
 
+## Foreign Language Support
+
+The Files.com Javascript SDK supports localized responses by using the `Files.setLanguage()` configuration method.
+When configured, this guides the API in selecting a preferred language for applicable response content.
+
+Language support currently applies to select human-facing fields only, such as notification messages
+and error descriptions.
+
+If the specified language is not supported or the value is omitted, the API defaults to English.
+
+```javascript title="Example Request"
+import Files from 'files.com/lib/Files';
+
+Files.setLanguage('es');
+```
+
 ## Errors
 
 The Files.com JavaScript SDK will return errors by raising exceptions. There are many exception classes defined in the Files SDK that correspond

package/_VERSION

@@ -1 +1 @@
-1.2.234
+1.2.236

package/docs/models/SsoStrategy.md

@@ -31,6 +31,7 @@
   "provision_group_inclusion": "Employees",
   "provision_group_required": "example",
   "provision_email_signup_groups": "Employees",
+  "provision_readonly_site_admin_groups": "Employees",
   "provision_site_admin_groups": "Employees",
   "provision_group_admin_groups": "Employees",
   "provision_attachments_permission": true,
@@ -81,6 +82,7 @@
 * `provision_group_inclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
 * `provision_group_required` (string): Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
 * `provision_email_signup_groups` (string): Comma-separated list of group names whose members will be created with email_signup authentication.
+* `provision_readonly_site_admin_groups` (string): Comma-separated list of group names whose members will be created as Read-Only Site Admins.
 * `provision_site_admin_groups` (string): Comma-separated list of group names whose members will be created as Site Admins.
 * `provision_group_admin_groups` (string): Comma-separated list of group names whose members will be provisioned as Group Admins.
 * `provision_attachments_permission` (boolean): 

package/lib/Api.js

@@ -266,6 +266,7 @@ _Api = Api;
     var params,
       options,
       metadata,
+      languageHeader,
       headers,
       isExternal,
       sessionId,
@@ -294,39 +295,42 @@ _Api = Api;
           params = _args4.length > 2 && _args4[2] !== undefined ? _args4[2] : null;
           options = _args4.length > 3 && _args4[3] !== undefined ? _args4[3] : {};
           metadata = _args4.length > 4 && _args4[4] !== undefined ? _args4[4] : null;
-          headers = _objectSpread(_objectSpread({
+          languageHeader = _Files.default.getLanguage() ? {
+            'Accept-Language': _Files.default.getLanguage()
+          } : {};
+          headers = _objectSpread(_objectSpread(_objectSpread({
             Accept: 'application/json'
-          }, options.headers), {}, {
+          }, languageHeader), options.headers), {}, {
             'User-Agent': _Files.default.getUserAgent()
           });
           isExternal = /^[a-zA-Z]+:\/\//.test(path);
           if (isExternal) {
-            _context4.next = 17;
+            _context4.next = 18;
             break;
           }
           sessionId = options.sessionId || _Files.default.getSessionId();
           if (!sessionId) {
-            _context4.next = 11;
+            _context4.next = 12;
             break;
           }
           headers['X-FilesAPI-Auth'] = sessionId;
-          _context4.next = 17;
+          _context4.next = 18;
           break;
-        case 11:
+        case 12:
           isCreatingSession = path === '/sessions' && verb.toUpperCase() === 'POST'; // api key cannot be used when creating a session
           if (isCreatingSession) {
-            _context4.next = 17;
+            _context4.next = 18;
             break;
           }
           apiKey = options.apiKey || _Files.default.getApiKey();
           if (apiKey) {
-            _context4.next = 16;
+            _context4.next = 17;
             break;
           }
           throw new errors.ConfigurationError('API key has not been set - use Files.setApiKey() to set it');
-        case 16:
-          headers['X-FilesAPI-Key'] = apiKey;
         case 17:
+          headers['X-FilesAPI-Key'] = apiKey;
+        case 18:
           updatedOptions = _objectSpread(_objectSpread({}, options), {}, {
             headers: headers
           });
@@ -368,12 +372,12 @@ _Api = Api;
               })
             }));
           }
-          _context4.next = 24;
+          _context4.next = 25;
           return _Api._sendVerbatim(requestPath, verb, updatedOptions);
-        case 24:
+        case 25:
           response = _context4.sent;
           return _context4.abrupt("return", _Api._autoPaginate(path, verb, params, updatedOptions, response, metadata));
-        case 26:
+        case 27:
         case "end":
           return _context4.stop();
       }

package/lib/Files.js

@@ -11,7 +11,8 @@ var endpointPrefix = '/api/rest/v1';
 var apiKey;
 var baseUrl = 'https://app.files.com';
 var sessionId = null;
-var version = '1.2.234';
+var language = null;
+var version = '1.2.236';
 var userAgent = "Files.com JavaScript SDK v".concat(version);
 var logLevel = _Logger.LogLevel.INFO;
 var debugRequest = false;
@@ -48,6 +49,12 @@ var Files = /*#__PURE__*/(0, _createClass2.default)(function Files() {
 (0, _defineProperty2.default)(Files, "getSessionId", function () {
   return sessionId;
 });
+(0, _defineProperty2.default)(Files, "getLanguage", function () {
+  return language;
+});
+(0, _defineProperty2.default)(Files, "setLanguage", function (value) {
+  language = value;
+});
 (0, _defineProperty2.default)(Files, "getEndpointPrefix", function () {
   return endpointPrefix;
 });

package/lib/models/SsoStrategy.js

@@ -141,6 +141,10 @@ var SsoStrategy = /*#__PURE__*/(0, _createClass2.default)(function SsoStrategy()
   (0, _defineProperty2.default)(this, "getProvisionEmailSignupGroups", function () {
     return _this.attributes.provision_email_signup_groups;
   });
+  // string # Comma-separated list of group names whose members will be created as Read-Only Site Admins.
+  (0, _defineProperty2.default)(this, "getProvisionReadonlySiteAdminGroups", function () {
+    return _this.attributes.provision_readonly_site_admin_groups;
+  });
   // string # Comma-separated list of group names whose members will be created as Site Admins.
   (0, _defineProperty2.default)(this, "getProvisionSiteAdminGroups", function () {
     return _this.attributes.provision_site_admin_groups;

package/package.json

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

package/src/Api.js

@@ -172,8 +172,11 @@ class Api {
   }
 
   static sendRequest = async (path, verb, params = null, options = {}, metadata = null) => {
+    const languageHeader = Files.getLanguage() ? { 'Accept-Language': Files.getLanguage() } : {}
+
     const headers = {
       Accept: 'application/json',
+      ...languageHeader,
       ...options.headers,
       'User-Agent': Files.getUserAgent(),
     }

package/src/Files.js

@@ -5,7 +5,8 @@ const endpointPrefix = '/api/rest/v1'
 let apiKey
 let baseUrl = 'https://app.files.com'
 let sessionId = null
-const version = '1.2.234'
+let language = null
+const version = '1.2.236'
 let userAgent = `Files.com JavaScript SDK v${version}`
 
 let logLevel = LogLevel.INFO
@@ -35,6 +36,10 @@ class Files {
 
   static getSessionId = () => sessionId
 
+  static getLanguage = () => language
+
+  static setLanguage = value => { language = value }
+
   static getEndpointPrefix = () => endpointPrefix
 
   static setLogLevel = value => { logLevel = value }

package/src/models/SsoStrategy.js

@@ -109,6 +109,9 @@ class SsoStrategy {
   // string # Comma-separated list of group names whose members will be created with email_signup authentication.
   getProvisionEmailSignupGroups = () => this.attributes.provision_email_signup_groups
 
+  // string # Comma-separated list of group names whose members will be created as Read-Only Site Admins.
+  getProvisionReadonlySiteAdminGroups = () => this.attributes.provision_readonly_site_admin_groups
+
   // string # Comma-separated list of group names whose members will be created as Site Admins.
   getProvisionSiteAdminGroups = () => this.attributes.provision_site_admin_groups
 

package/test/integration/src/index.js

@@ -1,3 +1,39 @@
+///////////////////////////////////////////////////////////////////////////////
+// To run this test suite, first set environment variables:
+//
+// required:
+//   FILES_API_KEY - set to your API key
+//   FILES_API_DOMAIN - set to your Files.com subdomain (e.g. mysite.files.com)
+//
+// required only if testSession() is run, otherwise can be omitted:
+//   FILES_SESSION_USERNAME - username to login with
+//   FILES_SESSION_PASSWORD - password to login with
+//
+// optional:
+//   USER_COUNT_TO_TRIGGER_PAGINATION - defaults to 1, set to a number that will
+//     require multiple page requests to fetch all users, but don't set it too low;
+//     if you have many users, then "1" will trigger a fetch for every single user
+//
+///////////////////////////////////////////////////////////////////////////////
+//
+// Next, in the ../../../ directory, build the SDK:
+//
+// npm install
+// npm run build
+//
+// Then, in the ../ directory, build the test suite:
+//
+// npm install
+// npm run build
+//
+// Finally, execute the current file:
+//
+// npm run test
+//
+///////////////////////////////////////////////////////////////////////////////
+// Note: you can comment out at the bottom of this file any tests you don't want to run.
+///////////////////////////////////////////////////////////////////////////////
+
 import Files from 'files.com/lib/Files'
 import Logger, { LogLevel } from 'files.com/lib/Logger'
 import ApiKey from 'files.com/lib/models/ApiKey'
@@ -27,13 +63,15 @@ if (!apiDomain) {
 Files.setApiKey(apiKey)
 Files.setBaseUrl(`https://${apiDomain}`)
 
-// temp for testing against staging
 if (apiDomain.substr(-10) === 'staging.av') {
   process.env.NODE_TLS_REJECT_UNAUTHORIZED = 0
 }
 
 const DEBUG_MODE = false
 
+// any user count that will require multiple page requests to fetch all users
+const USER_COUNT_TO_TRIGGER_PAGINATION = process.env.USER_COUNT_TO_TRIGGER_PAGINATION || 1
+
 Files.setLogLevel(DEBUG_MODE ? LogLevel.DEBUG : LogLevel.INFO)
 
 Files.configureDebugging({
@@ -53,7 +91,7 @@ const testSuite = async () => {
       autoPaginate: false,
     })
 
-    const firstPageItems = await Folder.listFor('/', { per_page: 1 })
+    const firstPageItems = await Folder.listFor('/', { per_page: USER_COUNT_TO_TRIGGER_PAGINATION })
 
     invariant(firstPageItems.length === 1, 'First page should have 1 item')
 
@@ -260,6 +298,41 @@ const testSuite = async () => {
     Logger.info('***** testUserListAndUpdate() succeeded! *****');
   }
 
+  const testLanguage = async () => {
+    Files.setLanguage('es');
+    invariant(Files.getLanguage() === 'es');
+
+    const savedLogLevel = Files.getLogLevel()
+    const savedDebugRequest = Files.shouldDebugRequest()
+    const savedDebugResponseHeaders = Files.shouldDebugResponseHeaders()
+    Files.setLogLevel(LogLevel.DEBUG)
+    Files.configureDebugging({
+      debugRequest: true,
+      debugResponseHeaders: true,
+    })
+
+    const logs = []
+    const savedConsoleLog = console.log
+    console.log = (...args) => {
+      logs.push(args.map(JSON.stringify).join(' '))
+    }
+
+    await ApiKey.list({ user_id: 0 })
+
+    console.log = savedConsoleLog
+
+    Files.setLogLevel(savedLogLevel)
+    Files.configureDebugging({
+      debugRequest: savedDebugRequest,
+      debugResponseHeaders: savedDebugResponseHeaders,
+    })
+
+    const allLogs = logs.join('\n')
+    invariant(allLogs.includes('"Accept-Language":"es"'), '"Accept-Language: es" header not found in debug output');
+
+    Logger.info('***** testLanguage() succeeded! *****');
+  }
+
   //
   // execute all tests
   //
@@ -273,6 +346,7 @@ const testSuite = async () => {
     await testSession()
     await testFailure()
     await testUserListAndUpdate()
+    await testLanguage()
   } catch (error) {
     console.log('*** TEST SUITE FAILED ***')
     console.error(error)