roboto-js 1.7.4 → 1.8.1

package/dist/cjs/rbt_api.cjs

@@ -11,8 +11,12 @@ var _rbt_user = _interopRequireDefault(require("./rbt_user.cjs"));
 var _rbt_file = _interopRequireDefault(require("./rbt_file.cjs"));
 var _lodash = _interopRequireDefault(require("lodash"));
 var _idb = require("idb");
+var _excluded = ["enableRealtime"],
+  _excluded2 = ["enableRealtime"];
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
+function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
@@ -1164,6 +1168,10 @@ var RbtApi = exports["default"] = /*#__PURE__*/function () {
      * - limit: An object to control the pagination of results. It includes:
      *    - offset: The starting point from where to fetch the results.
      *    - results: The maximum number of results to return.
+     * - requestAttrs: An array of attribute paths to include in the response (e.g., ['id', 'configs.title', 'configs.description']).
+     *                 If not provided, all attributes are returned.
+     * - excludeAttrs: An array of attribute paths to exclude from the response (e.g., ['details.log', 'internalData']).
+     *                 Excludes the specified paths and all their subpaths.
      * - resolveReferences: An array of attribute names whose references should be resolved in the returned objects.
      * - timeout: A numerical value in milliseconds to set a maximum time limit for the query execution.
      *
@@ -1172,6 +1180,8 @@ var RbtApi = exports["default"] = /*#__PURE__*/function () {
      *     where: 'email="tom@pospa.com"',
      *     orderBy: { column: 'timeCreated', direction: 'DESC' },
      *     limit: { offset: 0, results: 50 },
+     *     requestAttrs: ['id', 'configs.title'],
+     *     excludeAttrs: ['details.log'],
      *     resolveReferences: ['translatableContent']
      *   });
      *
@@ -1185,6 +1195,8 @@ var RbtApi = exports["default"] = /*#__PURE__*/function () {
         var _this6 = this;
         var params,
           paramsKey,
+          validParams,
+          invalidParams,
           defaultOrderBy,
           defaultLimit,
           mergedParams,
@@ -1199,6 +1211,21 @@ var RbtApi = exports["default"] = /*#__PURE__*/function () {
               params = _args22.length > 1 && _args22[1] !== undefined ? _args22[1] : {};
               _context22.prev = 1;
               //console.log('RBTAPI.query INIT', type, params);
+              // Validate parameters - reject invalid parameter names
+              validParams = ['type', 'where', 'orderBy', 'limit', 'resolveReferences', 'requestAttrs', 'excludeAttrs', 'timeout', 'enableRealtime'];
+              invalidParams = Object.keys(params).filter(function (key) {
+                return !validParams.includes(key);
+              });
+              if (!(invalidParams.length > 0)) {
+                _context22.next = 6;
+                break;
+              }
+              throw new Error("Invalid query parameter(s): ".concat(invalidParams.join(', '), ". Valid parameters are: ").concat(validParams.join(', ')));
+            case 6:
+              // Warn if enableRealtime is passed to query() - it should only be used by load()
+              if (params.enableRealtime) {
+                console.warn('[roboto-js] enableRealtime should not be passed to query(), only to load(). This parameter will be ignored.');
+              }
               params.type = type;
 
               // Default ordering and pagination
@@ -1219,11 +1246,11 @@ var RbtApi = exports["default"] = /*#__PURE__*/function () {
               paramsKey = JSON.stringify(mergedParams);
               cacheEntry = this.requestCache[paramsKey];
               if (!(cacheEntry && currentTime - cacheEntry.time < 10000)) {
-                _context22.next = 11;
+                _context22.next = 16;
                 break;
               }
               return _context22.abrupt("return", cacheEntry.val);
-            case 11:
+            case 16:
               // Create the response promise
               responsePromise = this.axios.post('/object_service/queryObjects', [mergedParams]); // Cache the promise of processing data, not just the raw response
               processingPromise = responsePromise.then(function (response) {
@@ -1239,21 +1266,21 @@ var RbtApi = exports["default"] = /*#__PURE__*/function () {
               };
 
               // Await the processing promise for this call to get processed data
-              _context22.next = 16;
+              _context22.next = 21;
               return processingPromise;
-            case 16:
+            case 21:
               return _context22.abrupt("return", _context22.sent);
-            case 19:
-              _context22.prev = 19;
+            case 24:
+              _context22.prev = 24;
               _context22.t0 = _context22["catch"](1);
               delete this.requestCache[paramsKey]; // Ensure cache cleanup on error
               //console.log('RBTAPI.query ERROR', paramsKey, e);
               return _context22.abrupt("return", this._handleError(_context22.t0));
-            case 23:
+            case 28:
             case "end":
               return _context22.stop();
           }
-        }, _callee22, this, [[1, 19]]);
+        }, _callee22, this, [[1, 24]]);
       }));
       function query(_x13) {
         return _query.apply(this, arguments);
@@ -1319,6 +1346,8 @@ var RbtApi = exports["default"] = /*#__PURE__*/function () {
           hitLogKey,
           loadedObjects,
           bulkMissLogKey,
+          enableRealtime,
+          queryParams,
           _iterator4,
           _step4,
           obj,
@@ -1346,7 +1375,7 @@ var RbtApi = exports["default"] = /*#__PURE__*/function () {
               }
               _context24.prev = 2;
               if (!Array.isArray(ids)) {
-                _context24.next = 24;
+                _context24.next = 25;
                 break;
               }
               // For array requests, check cache for each ID and only load missing ones
@@ -1393,7 +1422,7 @@ var RbtApi = exports["default"] = /*#__PURE__*/function () {
               }
               loadedObjects = [];
               if (!(missingIds.length > 0)) {
-                _context24.next = 18;
+                _context24.next = 19;
                 break;
               }
               // Only log bulk cache miss once
@@ -1405,12 +1434,15 @@ var RbtApi = exports["default"] = /*#__PURE__*/function () {
                 });
                 this._loggedCacheEvents.add(bulkMissLogKey);
               }
-              mergedParams = _objectSpread(_objectSpread({}, params), {}, {
+
+              // Remove load-specific params that shouldn't be passed to query
+              enableRealtime = params.enableRealtime, queryParams = _objectWithoutProperties(params, _excluded);
+              mergedParams = _objectSpread(_objectSpread({}, queryParams), {}, {
                 where: "id IN (\"".concat(missingIds.join("\",\""), "\")")
               });
-              _context24.next = 15;
+              _context24.next = 16;
               return this.query(type, mergedParams);
-            case 15:
+            case 16:
               loadedObjects = _context24.sent;
               // Cache the newly loaded objects
               _iterator4 = _createForOfIteratorHelper(loadedObjects);
@@ -1435,7 +1467,7 @@ var RbtApi = exports["default"] = /*#__PURE__*/function () {
               } finally {
                 _iterator4.f();
               }
-            case 18:
+            case 19:
               // Return combined results in original order
               result = [];
               _iterator5 = _createForOfIteratorHelper(ids);
@@ -1458,12 +1490,12 @@ var RbtApi = exports["default"] = /*#__PURE__*/function () {
                 _iterator5.f();
               }
               return _context24.abrupt("return", result);
-            case 24:
+            case 25:
               // For single object requests, check cache first
               _cacheKey3 = "".concat(type, ":").concat(ids);
               _cached = this._objectCache.get(_cacheKey3);
               if (!_cached) {
-                _context24.next = 31;
+                _context24.next = 32;
                 break;
               }
               // Only log cache hits once per object to reduce spam
@@ -1486,18 +1518,18 @@ var RbtApi = exports["default"] = /*#__PURE__*/function () {
                 _cached._initRealtime();
               }
               return _context24.abrupt("return", _cached);
-            case 31:
+            case 32:
               // Check if we're already loading this object
               pendingKey = "".concat(type, ":").concat(ids);
               if (!this._pendingLoads.has(pendingKey)) {
-                _context24.next = 36;
+                _context24.next = 37;
                 break;
               }
-              _context24.next = 35;
+              _context24.next = 36;
               return this._pendingLoads.get(pendingKey);
-            case 35:
-              return _context24.abrupt("return", _context24.sent);
             case 36:
+              return _context24.abrupt("return", _context24.sent);
+            case 37:
               // Only log cache miss once per object to reduce spam
               missLogKey = "miss:".concat(_cacheKey3);
               if (!this._loggedCacheEvents.has(missLogKey)) {
@@ -1510,17 +1542,19 @@ var RbtApi = exports["default"] = /*#__PURE__*/function () {
 
               // Create the loading promise and store it to prevent duplicate requests
               loadPromise = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee23() {
-                var res, _obj2, _setLogKey;
+                var _enableRealtime, _queryParams, res, _obj2, _setLogKey;
                 return _regeneratorRuntime().wrap(function _callee23$(_context23) {
                   while (1) switch (_context23.prev = _context23.next) {
                     case 0:
                       _context23.prev = 0;
-                      mergedParams = _objectSpread(_objectSpread({}, params), {}, {
+                      // Remove load-specific params that shouldn't be passed to query
+                      _enableRealtime = params.enableRealtime, _queryParams = _objectWithoutProperties(params, _excluded2);
+                      mergedParams = _objectSpread(_objectSpread({}, _queryParams), {}, {
                         where: "id=\"".concat(ids, "\"")
                       });
-                      _context23.next = 4;
+                      _context23.next = 5;
                       return _this8.query(type, mergedParams);
-                    case 4:
+                    case 5:
                       res = _context23.sent;
                       _obj2 = res[0];
                       if (_obj2) {
@@ -1538,34 +1572,34 @@ var RbtApi = exports["default"] = /*#__PURE__*/function () {
                         }
                       }
                       return _context23.abrupt("return", _obj2);
-                    case 8:
-                      _context23.prev = 8;
+                    case 9:
+                      _context23.prev = 9;
                       // Remove from pending loads
                       _this8._pendingLoads["delete"](pendingKey);
-                      return _context23.finish(8);
-                    case 11:
+                      return _context23.finish(9);
+                    case 12:
                     case "end":
                       return _context23.stop();
                   }
-                }, _callee23, null, [[0,, 8, 11]]);
+                }, _callee23, null, [[0,, 9, 12]]);
               }))(); // Store the promise so other concurrent requests can await it
               this._pendingLoads.set(pendingKey, loadPromise);
-              _context24.next = 42;
+              _context24.next = 43;
               return loadPromise;
-            case 42:
-              return _context24.abrupt("return", _context24.sent);
             case 43:
-              _context24.next = 48;
+              return _context24.abrupt("return", _context24.sent);
+            case 44:
+              _context24.next = 49;
               break;
-            case 45:
-              _context24.prev = 45;
+            case 46:
+              _context24.prev = 46;
               _context24.t0 = _context24["catch"](2);
               return _context24.abrupt("return", this._handleError(_context24.t0));
-            case 48:
+            case 49:
             case "end":
               return _context24.stop();
           }
-        }, _callee24, this, [[2, 45]]);
+        }, _callee24, this, [[2, 46]]);
       }));
       function load(_x14, _x15) {
         return _load.apply(this, arguments);