@plasmicapp/data-sources - npm Package Compare versions

Comparing version 0.1.86 to 0.1.87

dist/data-sources.cjs.development.js

@@ -7,5 +7,6 @@ 'use strict';
 
-var query = require('@plasmicapp/query');
+var plasmicQuery = require('@plasmicapp/query');
 var React = _interopDefault(require('react'));
 var dataSourcesContext = require('@plasmicapp/data-sources-context');
+var ph = require('@plasmicapp/host');
 var fetch = _interopDefault(require('@plasmicapp/isomorphic-unfetch'));
@@ -731,3 +732,3 @@ var stringify = _interopDefault(require('fast-stringify'));
             _context.next = 3;
-            return query.wrapLoadingFetcher(func)(op, opts);
+            return plasmicQuery.wrapLoadingFetcher(func)(op, opts);
           case 3:
@@ -848,32 +849,68 @@ res = _context.sent;
 }
+var enableLoadingBoundaryKey = 'plasmicInternalEnableLoadingBoundary';
+function mkUndefinedDataProxy(promiseRef, fetchAndUpdateCache) {
+  return new Proxy({}, {
+    get: function get(_target, prop) {
+      if (prop === 'isPlasmicUndefinedDataProxy') {
+        return true;
+      }
+      var promise = promiseRef.fetchingPromise || fetchAndUpdateCache();
+      promise.plasmicType = 'PlasmicUndefinedDataError';
+      promise.message = "Cannot read property " + String(prop) + " - data is still loading";
+      throw promise;
+    }
+  });
+}
+var reactMajorVersion = + /*#__PURE__*/React.version.split('.')[0];
 function usePlasmicDataOp(dataOp, opts) {
+  var _ph$useDataEnv;
   var ctx = dataSourcesContext.usePlasmicDataSourceContext();
-  var res = query.useMutablePlasmicQueryData(function () {
-    if (!dataOp) {
-      return null;
-    }
-    return makeCacheKey(dataOp, {
-      paginate: opts == null ? void 0 : opts.paginate,
-      userAuthToken: ctx == null ? void 0 : ctx.userAuthToken
-    });
-  }, /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee() {
-    return runtime_1.wrap(function _callee$(_context) {
-      while (1) {
-        switch (_context.prev = _context.next) {
-          case 0:
-            _context.next = 2;
-            return executePlasmicDataOp(dataOp, {
-              userAuthToken: (ctx == null ? void 0 : ctx.userAuthToken) || undefined,
-              user: ctx == null ? void 0 : ctx.user,
-              paginate: opts == null ? void 0 : opts.paginate
-            });
-          case 2:
-            return _context.abrupt("return", _context.sent);
-          case 3:
-          case "end":
-            return _context.stop();
-        }
+  var enableLoadingBoundary = !!(ph.useDataEnv != null && (_ph$useDataEnv = ph.useDataEnv()) != null && _ph$useDataEnv[enableLoadingBoundaryKey]);
+  // Check if `useSWRConfig` exists for backwards compatibility.
+  var config = plasmicQuery.useSWRConfig == null ? void 0 : plasmicQuery.useSWRConfig();
+  var cache = config == null ? void 0 : config.cache;
+  var isNullDataOp = !dataOp;
+  var key = isNullDataOp ? null : makeCacheKey(dataOp, {
+    paginate: opts == null ? void 0 : opts.paginate,
+    userAuthToken: ctx == null ? void 0 : ctx.userAuthToken
+  });
+  var fetchingData = React.useMemo(function () {
+    return {
+      fetchingPromise: undefined
+    };
+  }, [key]);
+  var fetcher = React.useMemo(function () {
+    return function () {
+      if (fetchingData.fetchingPromise) {
+        return fetchingData.fetchingPromise;
       }
-    }, _callee);
-  })), {
+      var fetcherFn = function fetcherFn() {
+        return (
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+          executePlasmicDataOp(dataOp, {
+            userAuthToken: (ctx == null ? void 0 : ctx.userAuthToken) || undefined,
+            user: ctx == null ? void 0 : ctx.user,
+            paginate: opts == null ? void 0 : opts.paginate
+          })
+        );
+      };
+      var fetcherPromise = fetcherFn();
+      fetchingData.fetchingPromise = fetcherPromise;
+      return fetcherPromise;
+    };
+  }, [key, fetchingData]);
+  var fetchAndUpdateCache = React.useMemo(function () {
+    return cache ? function () {
+      if (fetchingData.fetchingPromise) {
+        // No need to update cache as the exist promise call site will do it
+        return fetchingData.fetchingPromise;
+      }
+      var fetcherPromise = fetcher();
+      fetcherPromise.then(function (data) {
+        return cache.set(key, data);
+      });
+      return fetcherPromise;
+    } : undefined;
+  }, [fetcher, fetchingData, cache]);
+  var res = plasmicQuery.useMutablePlasmicQueryData(key, fetcher, {
     shouldRetryOnError: false
@@ -885,24 +922,29 @@ });
   return React.useMemo(function () {
-    return _extends({}, data != null ? data : {}, pick(res, 'isLoading', 'error'));
-  }, [data, error, isLoading]);
+    var result = _extends({}, data != null ? data : {}, pick(res, 'isLoading', 'error'));
+    if (!(opts != null && opts.noUndefinedDataProxy) && reactMajorVersion >= 18 && enableLoadingBoundary && fetchAndUpdateCache && (isLoading || isNullDataOp) && result.data === undefined && result.schema === undefined) {
+      result.data = mkUndefinedDataProxy(fetchingData, fetchAndUpdateCache);
+      result.schema = mkUndefinedDataProxy(fetchingData, fetchAndUpdateCache);
+    }
+    return result;
+  }, [isNullDataOp, data, error, isLoading, opts == null ? void 0 : opts.noUndefinedDataProxy, enableLoadingBoundary, fetchingData, fetchAndUpdateCache]);
 }
 function usePlasmicDataMutationOp(dataOp) {
-  var _ref2 = dataOp != null ? dataOp : {},
-    sourceId = _ref2.sourceId,
-    opId = _ref2.opId,
-    userArgs = _ref2.userArgs;
+  var _ref = dataOp != null ? dataOp : {},
+    sourceId = _ref.sourceId,
+    opId = _ref.opId,
+    userArgs = _ref.userArgs;
   var ctx = dataSourcesContext.usePlasmicDataSourceContext();
   var userToken = ctx == null ? void 0 : ctx.userAuthToken;
-  return React.useCallback( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee2() {
-    return runtime_1.wrap(function _callee2$(_context2) {
+  return React.useCallback( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee() {
+    return runtime_1.wrap(function _callee$(_context) {
       while (1) {
-        switch (_context2.prev = _context2.next) {
+        switch (_context.prev = _context.next) {
           case 0:
             if (!(!sourceId || !opId)) {
-              _context2.next = 2;
+              _context.next = 2;
               break;
             }
-            return _context2.abrupt("return", undefined);
+            return _context.abrupt("return", undefined);
           case 2:
-            return _context2.abrupt("return", executePlasmicDataOp({
+            return _context.abrupt("return", executePlasmicDataOp({
               sourceId: sourceId,
@@ -917,6 +959,6 @@ opId: opId,
           case "end":
-            return _context2.stop();
+            return _context.stop();
         }
       }
-    }, _callee2);
+    }, _callee);
   })), [sourceId, opId, userArgs, userToken]);
@@ -989,2 +1031,5 @@ }
 }
+/**
+ * @deprecated Prefer using `usePlasmicDataOp` directly instead.
+ */
 function useDependencyAwareQuery(_ref) {
@@ -1020,3 +1065,3 @@ var $queries = _ref.$queries,
   get: function () {
-    return query.usePlasmicDataConfig;
+    return plasmicQuery.usePlasmicDataConfig;
   }
@@ -1023,0 +1068,0 @@ });

dist/data-sources.cjs.production.min.js

@@ -1,2 +0,2 @@
-"use strict";function e(e){return e&&"object"==typeof e&&"default"in e?e.default:e}Object.defineProperty(exports,"__esModule",{value:!0});var t=require("@plasmicapp/query"),r=e(require("react")),n=require("@plasmicapp/data-sources-context"),o=e(require("@plasmicapp/isomorphic-unfetch")),a=e(require("fast-stringify"));function i(e,t,r,n,o,a,i){try{var u=e[a](i),c=u.value}catch(e){return void r(e)}u.done?t(c):Promise.resolve(c).then(n,o)}function u(e){return function(){var t=this,r=arguments;return new Promise((function(n,o){var a=e.apply(t,r);function u(e){i(a,n,o,u,c,"next",e)}function c(e){i(a,n,o,u,c,"throw",e)}u(void 0)}))}}function c(){return(c=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var r=arguments[t];for(var n in r)Object.prototype.hasOwnProperty.call(r,n)&&(e[n]=r[n])}return e}).apply(this,arguments)}function s(e,t){return e(t={exports:{}},t.exports),t.exports}var l=s((function(e){var t=function(e){var t=Object.prototype,r=t.hasOwnProperty,n="function"==typeof Symbol?Symbol:{},o=n.iterator||"@@iterator",a=n.asyncIterator||"@@asyncIterator",i=n.toStringTag||"@@toStringTag";function u(e,t,r){return Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}),e[t]}try{u({},"")}catch(e){u=function(e,t,r){return e[t]=r}}function c(e,t,r,n){var o=Object.create((t&&t.prototype instanceof p?t:p).prototype),a=new O(n||[]);return o._invoke=function(e,t,r){var n="suspendedStart";return function(o,a){if("executing"===n)throw new Error("Generator is already running");if("completed"===n){if("throw"===o)throw a;return{value:void 0,done:!0}}for(r.method=o,r.arg=a;;){var i=r.delegate;if(i){var u=w(i,r);if(u){if(u===l)continue;return u}}if("next"===r.method)r.sent=r._sent=r.arg;else if("throw"===r.method){if("suspendedStart"===n)throw n="completed",r.arg;r.dispatchException(r.arg)}else"return"===r.method&&r.abrupt("return",r.arg);n="executing";var c=s(e,t,r);if("normal"===c.type){if(n=r.done?"completed":"suspendedYield",c.arg===l)continue;return{value:c.arg,done:r.done}}"throw"===c.type&&(n="completed",r.method="throw",r.arg=c.arg)}}}(e,r,a),o}function s(e,t,r){try{return{type:"normal",arg:e.call(t,r)}}catch(e){return{type:"throw",arg:e}}}e.wrap=c;var l={};function p(){}function f(){}function h(){}var d={};u(d,o,(function(){return this}));var v=Object.getPrototypeOf,y=v&&v(v(E([])));y&&y!==t&&r.call(y,o)&&(d=y);var g=h.prototype=p.prototype=Object.create(d);function m(e){["next","throw","return"].forEach((function(t){u(e,t,(function(e){return this._invoke(t,e)}))}))}function x(e,t){var n;this._invoke=function(o,a){function i(){return new t((function(n,i){!function n(o,a,i,u){var c=s(e[o],e,a);if("throw"!==c.type){var l=c.arg,p=l.value;return p&&"object"==typeof p&&r.call(p,"__await")?t.resolve(p.__await).then((function(e){n("next",e,i,u)}),(function(e){n("throw",e,i,u)})):t.resolve(p).then((function(e){l.value=e,i(l)}),(function(e){return n("throw",e,i,u)}))}u(c.arg)}(o,a,n,i)}))}return n=n?n.then(i,i):i()}}function w(e,t){var r=e.iterator[t.method];if(void 0===r){if(t.delegate=null,"throw"===t.method){if(e.iterator.return&&(t.method="return",t.arg=void 0,w(e,t),"throw"===t.method))return l;t.method="throw",t.arg=new TypeError("The iterator does not provide a 'throw' method")}return l}var n=s(r,e.iterator,t.arg);if("throw"===n.type)return t.method="throw",t.arg=n.arg,t.delegate=null,l;var o=n.arg;return o?o.done?(t[e.resultName]=o.value,t.next=e.nextLoc,"return"!==t.method&&(t.method="next",t.arg=void 0),t.delegate=null,l):o:(t.method="throw",t.arg=new TypeError("iterator result is not an object"),t.delegate=null,l)}function b(e){var t={tryLoc:e[0]};1 in e&&(t.catchLoc=e[1]),2 in e&&(t.finallyLoc=e[2],t.afterLoc=e[3]),this.tryEntries.push(t)}function L(e){var t=e.completion||{};t.type="normal",delete t.arg,e.completion=t}function O(e){this.tryEntries=[{tryLoc:"root"}],e.forEach(b,this),this.reset(!0)}function E(e){if(e){var t=e[o];if(t)return t.call(e);if("function"==typeof e.next)return e;if(!isNaN(e.length)){var n=-1,a=function t(){for(;++n<e.length;)if(r.call(e,n))return t.value=e[n],t.done=!1,t;return t.value=void 0,t.done=!0,t};return a.next=a}}return{next:k}}function k(){return{value:void 0,done:!0}}return f.prototype=h,u(g,"constructor",h),u(h,"constructor",f),f.displayName=u(h,i,"GeneratorFunction"),e.isGeneratorFunction=function(e){var t="function"==typeof e&&e.constructor;return!!t&&(t===f||"GeneratorFunction"===(t.displayName||t.name))},e.mark=function(e){return Object.setPrototypeOf?Object.setPrototypeOf(e,h):(e.__proto__=h,u(e,i,"GeneratorFunction")),e.prototype=Object.create(g),e},e.awrap=function(e){return{__await:e}},m(x.prototype),u(x.prototype,a,(function(){return this})),e.AsyncIterator=x,e.async=function(t,r,n,o,a){void 0===a&&(a=Promise);var i=new x(c(t,r,n,o),a);return e.isGeneratorFunction(r)?i:i.next().then((function(e){return e.done?e.value:i.next()}))},m(g),u(g,i,"Generator"),u(g,o,(function(){return this})),u(g,"toString",(function(){return"[object Generator]"})),e.keys=function(e){var t=[];for(var r in e)t.push(r);return t.reverse(),function r(){for(;t.length;){var n=t.pop();if(n in e)return r.value=n,r.done=!1,r}return r.done=!0,r}},e.values=E,O.prototype={constructor:O,reset:function(e){if(this.prev=0,this.next=0,this.sent=this._sent=void 0,this.done=!1,this.delegate=null,this.method="next",this.arg=void 0,this.tryEntries.forEach(L),!e)for(var t in this)"t"===t.charAt(0)&&r.call(this,t)&&!isNaN(+t.slice(1))&&(this[t]=void 0)},stop:function(){this.done=!0;var e=this.tryEntries[0].completion;if("throw"===e.type)throw e.arg;return this.rval},dispatchException:function(e){if(this.done)throw e;var t=this;function n(r,n){return i.type="throw",i.arg=e,t.next=r,n&&(t.method="next",t.arg=void 0),!!n}for(var o=this.tryEntries.length-1;o>=0;--o){var a=this.tryEntries[o],i=a.completion;if("root"===a.tryLoc)return n("end");if(a.tryLoc<=this.prev){var u=r.call(a,"catchLoc"),c=r.call(a,"finallyLoc");if(u&&c){if(this.prev<a.catchLoc)return n(a.catchLoc,!0);if(this.prev<a.finallyLoc)return n(a.finallyLoc)}else if(u){if(this.prev<a.catchLoc)return n(a.catchLoc,!0)}else{if(!c)throw new Error("try statement without catch or finally");if(this.prev<a.finallyLoc)return n(a.finallyLoc)}}}},abrupt:function(e,t){for(var n=this.tryEntries.length-1;n>=0;--n){var o=this.tryEntries[n];if(o.tryLoc<=this.prev&&r.call(o,"finallyLoc")&&this.prev<o.finallyLoc){var a=o;break}}a&&("break"===e||"continue"===e)&&a.tryLoc<=t&&t<=a.finallyLoc&&(a=null);var i=a?a.completion:{};return i.type=e,i.arg=t,a?(this.method="next",this.next=a.finallyLoc,l):this.complete(i)},complete:function(e,t){if("throw"===e.type)throw e.arg;return"break"===e.type||"continue"===e.type?this.next=e.arg:"return"===e.type?(this.rval=this.arg=e.arg,this.method="return",this.next="end"):"normal"===e.type&&t&&(this.next=t),l},finish:function(e){for(var t=this.tryEntries.length-1;t>=0;--t){var r=this.tryEntries[t];if(r.finallyLoc===e)return this.complete(r.completion,r.afterLoc),L(r),l}},catch:function(e){for(var t=this.tryEntries.length-1;t>=0;--t){var r=this.tryEntries[t];if(r.tryLoc===e){var n=r.completion;if("throw"===n.type){var o=n.arg;L(r)}return o}}throw new Error("illegal catch attempt")},delegateYield:function(e,t,r){return this.delegate={iterator:E(e),resultName:t,nextLoc:r},"next"===this.method&&(this.arg=void 0),l}},e}(e.exports);try{regeneratorRuntime=t}catch(e){"object"==typeof globalThis?globalThis.regeneratorRuntime=t:Function("r","regeneratorRuntime = r")(t)}})),p="You do not have permission to perform this operation. Login to get access or contact the app owner to get access.";function f(e,t){return h.apply(this,arguments)}function h(){return(h=u(l.mark((function e(r,n){var o;return l.wrap((function(e){for(;;)switch(e.prev=e.next){case 0:return o=y("__PLASMIC_EXECUTE_DATA_OP",d),e.next=3,t.wrapLoadingFetcher(o)(r,n);case 3:return e.abrupt("return",e.sent);case 5:case"end":return e.stop()}}),e)})))).apply(this,arguments)}function d(e,t){return v.apply(this,arguments)}function v(){return(v=u(l.mark((function e(t,r){var n,i,u,s;return l.wrap((function(e){for(;;)switch(e.prev=e.next){case 0:if(!t.roleId){e.next=4;break}if(null!=r&&r.user&&r.user.roleIds.includes(t.roleId)){e.next=4;break}throw console.error(p),new Error(p);case 4:return i=y("__PLASMIC_DATA_HOST","https://data.plasmic.app"),u=i+"/api/v1/server-data/sources/"+t.sourceId+"/execute",e.next=8,o(u,{method:"POST",headers:c({"Content-Type":"application/json"},(null==r?void 0:r.userAuthToken)&&{"x-plasmic-data-user-auth-token":r.userAuthToken}),body:a({opId:t.opId,userArgs:null!=(n=t.userArgs)?n:{},paginate:null==r?void 0:r.paginate})});case 8:if(200===(s=e.sent).status){e.next=14;break}return e.next=12,s.text();case 12:throw new Error(e.sent);case 14:return e.next=16,s.json();case 16:return e.abrupt("return",e.sent);case 17:case"end":return e.stop()}}),e)})))).apply(this,arguments)}function y(e,t){return"undefined"==typeof globalThis?t:null!=(r=globalThis[e])?r:t;var r}function g(e,t){var r=JSON.stringify({sourceId:e.sourceId,opId:e.opId,args:e.userArgs,userAuthToken:null==t?void 0:t.userAuthToken,paginate:null==t?void 0:t.paginate});return e.cacheKey?""+e.cacheKey+r:r}function m(e,o){var a=n.usePlasmicDataSourceContext(),i=t.useMutablePlasmicQueryData((function(){return e?g(e,{paginate:null==o?void 0:o.paginate,userAuthToken:null==a?void 0:a.userAuthToken}):null}),u(l.mark((function t(){return l.wrap((function(t){for(;;)switch(t.prev=t.next){case 0:return t.next=2,f(e,{userAuthToken:(null==a?void 0:a.userAuthToken)||void 0,user:null==a?void 0:a.user,paginate:null==o?void 0:o.paginate});case 2:return t.abrupt("return",t.sent);case 3:case"end":return t.stop()}}),t)}))),{shouldRetryOnError:!1}),s=i.data;return r.useMemo((function(){return c({},null!=s?s:{},function(e){for(var t={},r=arguments.length,n=new Array(r>1?r-1:0),o=1;o<r;o++)n[o-1]=arguments[o];for(var a=0,i=n;a<i.length;a++){var u=i[a];u in e&&(t[u]=e[u])}return t}(i,"isLoading","error"))}),[s,i.error,i.isLoading])}Object.defineProperty(exports,"usePlasmicDataConfig",{enumerable:!0,get:function(){return t.usePlasmicDataConfig}}),exports.Fetcher=function(e){var t,n=e.children,o=e.name,a=e.pageIndex,i=e.pageSize,u=m(e.dataOp,c({},!!a&&!!i&&{paginate:{pageIndex:a,pageSize:i}})),s=r.useMemo((function(){var t;return c({},e.queries,((t={})[null!=o?o:"data"]=u,t))}),[e.queries,o,u]);return null!=(t=null==n?void 0:n(s))?t:null},exports.FetcherMeta={name:"plasmic-data-source-fetcher",displayName:"Data Fetcher",props:{dataOp:{type:"dataSourceOp",displayName:"Data"},name:{type:"string",displayName:"Variable name"},children:{type:"slot",renderPropParams:["$queries"]},pageSize:{type:"number",advanced:!0,displayName:"Page size",description:"Only fetch in batches of this size; for pagination"},pageIndex:{type:"number",advanced:!0,displayName:"Page index",description:"0-based index of the paginated page to fetch"}},importPath:"@plasmicapp/react-web/lib/data-sources",importName:"Fetcher",alwaysAutoName:!0,styleSections:!1},exports.executePlasmicDataOp=f,exports.makeCacheKey=g,exports.useDependencyAwareQuery=function(e){var t,n,o=e.$queries,a=e.setDollarQueries,i=e.name,u=e.pageIndex,s=e.pageSize,l=m(function(e){try{return e()}catch(e){return}}(e.getDataOp),c({},!!u&&!!s&&{paginate:{pageIndex:u,pageSize:s}})),p=null!=i?i:"data",f=(t=p,n=r.useRef(void 0),r.useEffect((function(){return n.current=t,function(){n.current=void 0}})),n.current);r.useEffect((function(){if(!(p in o)||o[p]!==l){var e,t=c({},o,((e={})[p]=l,e));f&&p!==f&&f in o&&delete t[f],a(t)}}),[p,f,l,o,a])},exports.usePlasmicDataMutationOp=function(e){var t=null!=e?e:{},o=t.sourceId,a=t.opId,i=t.userArgs,c=n.usePlasmicDataSourceContext(),s=null==c?void 0:c.userAuthToken;return r.useCallback(u(l.mark((function e(){return l.wrap((function(e){for(;;)switch(e.prev=e.next){case 0:if(o&&a){e.next=2;break}return e.abrupt("return",void 0);case 2:return e.abrupt("return",f({sourceId:o,opId:a,userArgs:i},{userAuthToken:s||void 0,user:null==c?void 0:c.user}));case 3:case"end":return e.stop()}}),e)}))),[o,a,i,s])},exports.usePlasmicDataOp=m;
+"use strict";function e(e){return e&&"object"==typeof e&&"default"in e?e.default:e}Object.defineProperty(exports,"__esModule",{value:!0});var t=require("@plasmicapp/query"),r=e(require("react")),n=require("@plasmicapp/data-sources-context"),o=require("@plasmicapp/host"),a=e(require("@plasmicapp/isomorphic-unfetch")),i=e(require("fast-stringify"));function u(e,t,r,n,o,a,i){try{var u=e[a](i),c=u.value}catch(e){return void r(e)}u.done?t(c):Promise.resolve(c).then(n,o)}function c(e){return function(){var t=this,r=arguments;return new Promise((function(n,o){var a=e.apply(t,r);function i(e){u(a,n,o,i,c,"next",e)}function c(e){u(a,n,o,i,c,"throw",e)}i(void 0)}))}}function s(){return(s=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var r=arguments[t];for(var n in r)Object.prototype.hasOwnProperty.call(r,n)&&(e[n]=r[n])}return e}).apply(this,arguments)}function l(e,t){return e(t={exports:{}},t.exports),t.exports}var p=l((function(e){var t=function(e){var t=Object.prototype,r=t.hasOwnProperty,n="function"==typeof Symbol?Symbol:{},o=n.iterator||"@@iterator",a=n.asyncIterator||"@@asyncIterator",i=n.toStringTag||"@@toStringTag";function u(e,t,r){return Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}),e[t]}try{u({},"")}catch(e){u=function(e,t,r){return e[t]=r}}function c(e,t,r,n){var o=Object.create((t&&t.prototype instanceof p?t:p).prototype),a=new L(n||[]);return o._invoke=function(e,t,r){var n="suspendedStart";return function(o,a){if("executing"===n)throw new Error("Generator is already running");if("completed"===n){if("throw"===o)throw a;return{value:void 0,done:!0}}for(r.method=o,r.arg=a;;){var i=r.delegate;if(i){var u=w(i,r);if(u){if(u===l)continue;return u}}if("next"===r.method)r.sent=r._sent=r.arg;else if("throw"===r.method){if("suspendedStart"===n)throw n="completed",r.arg;r.dispatchException(r.arg)}else"return"===r.method&&r.abrupt("return",r.arg);n="executing";var c=s(e,t,r);if("normal"===c.type){if(n=r.done?"completed":"suspendedYield",c.arg===l)continue;return{value:c.arg,done:r.done}}"throw"===c.type&&(n="completed",r.method="throw",r.arg=c.arg)}}}(e,r,a),o}function s(e,t,r){try{return{type:"normal",arg:e.call(t,r)}}catch(e){return{type:"throw",arg:e}}}e.wrap=c;var l={};function p(){}function f(){}function h(){}var d={};u(d,o,(function(){return this}));var v=Object.getPrototypeOf,y=v&&v(v(E([])));y&&y!==t&&r.call(y,o)&&(d=y);var g=h.prototype=p.prototype=Object.create(d);function m(e){["next","throw","return"].forEach((function(t){u(e,t,(function(e){return this._invoke(t,e)}))}))}function x(e,t){var n;this._invoke=function(o,a){function i(){return new t((function(n,i){!function n(o,a,i,u){var c=s(e[o],e,a);if("throw"!==c.type){var l=c.arg,p=l.value;return p&&"object"==typeof p&&r.call(p,"__await")?t.resolve(p.__await).then((function(e){n("next",e,i,u)}),(function(e){n("throw",e,i,u)})):t.resolve(p).then((function(e){l.value=e,i(l)}),(function(e){return n("throw",e,i,u)}))}u(c.arg)}(o,a,n,i)}))}return n=n?n.then(i,i):i()}}function w(e,t){var r=e.iterator[t.method];if(void 0===r){if(t.delegate=null,"throw"===t.method){if(e.iterator.return&&(t.method="return",t.arg=void 0,w(e,t),"throw"===t.method))return l;t.method="throw",t.arg=new TypeError("The iterator does not provide a 'throw' method")}return l}var n=s(r,e.iterator,t.arg);if("throw"===n.type)return t.method="throw",t.arg=n.arg,t.delegate=null,l;var o=n.arg;return o?o.done?(t[e.resultName]=o.value,t.next=e.nextLoc,"return"!==t.method&&(t.method="next",t.arg=void 0),t.delegate=null,l):o:(t.method="throw",t.arg=new TypeError("iterator result is not an object"),t.delegate=null,l)}function b(e){var t={tryLoc:e[0]};1 in e&&(t.catchLoc=e[1]),2 in e&&(t.finallyLoc=e[2],t.afterLoc=e[3]),this.tryEntries.push(t)}function P(e){var t=e.completion||{};t.type="normal",delete t.arg,e.completion=t}function L(e){this.tryEntries=[{tryLoc:"root"}],e.forEach(b,this),this.reset(!0)}function E(e){if(e){var t=e[o];if(t)return t.call(e);if("function"==typeof e.next)return e;if(!isNaN(e.length)){var n=-1,a=function t(){for(;++n<e.length;)if(r.call(e,n))return t.value=e[n],t.done=!1,t;return t.value=void 0,t.done=!0,t};return a.next=a}}return{next:O}}function O(){return{value:void 0,done:!0}}return f.prototype=h,u(g,"constructor",h),u(h,"constructor",f),f.displayName=u(h,i,"GeneratorFunction"),e.isGeneratorFunction=function(e){var t="function"==typeof e&&e.constructor;return!!t&&(t===f||"GeneratorFunction"===(t.displayName||t.name))},e.mark=function(e){return Object.setPrototypeOf?Object.setPrototypeOf(e,h):(e.__proto__=h,u(e,i,"GeneratorFunction")),e.prototype=Object.create(g),e},e.awrap=function(e){return{__await:e}},m(x.prototype),u(x.prototype,a,(function(){return this})),e.AsyncIterator=x,e.async=function(t,r,n,o,a){void 0===a&&(a=Promise);var i=new x(c(t,r,n,o),a);return e.isGeneratorFunction(r)?i:i.next().then((function(e){return e.done?e.value:i.next()}))},m(g),u(g,i,"Generator"),u(g,o,(function(){return this})),u(g,"toString",(function(){return"[object Generator]"})),e.keys=function(e){var t=[];for(var r in e)t.push(r);return t.reverse(),function r(){for(;t.length;){var n=t.pop();if(n in e)return r.value=n,r.done=!1,r}return r.done=!0,r}},e.values=E,L.prototype={constructor:L,reset:function(e){if(this.prev=0,this.next=0,this.sent=this._sent=void 0,this.done=!1,this.delegate=null,this.method="next",this.arg=void 0,this.tryEntries.forEach(P),!e)for(var t in this)"t"===t.charAt(0)&&r.call(this,t)&&!isNaN(+t.slice(1))&&(this[t]=void 0)},stop:function(){this.done=!0;var e=this.tryEntries[0].completion;if("throw"===e.type)throw e.arg;return this.rval},dispatchException:function(e){if(this.done)throw e;var t=this;function n(r,n){return i.type="throw",i.arg=e,t.next=r,n&&(t.method="next",t.arg=void 0),!!n}for(var o=this.tryEntries.length-1;o>=0;--o){var a=this.tryEntries[o],i=a.completion;if("root"===a.tryLoc)return n("end");if(a.tryLoc<=this.prev){var u=r.call(a,"catchLoc"),c=r.call(a,"finallyLoc");if(u&&c){if(this.prev<a.catchLoc)return n(a.catchLoc,!0);if(this.prev<a.finallyLoc)return n(a.finallyLoc)}else if(u){if(this.prev<a.catchLoc)return n(a.catchLoc,!0)}else{if(!c)throw new Error("try statement without catch or finally");if(this.prev<a.finallyLoc)return n(a.finallyLoc)}}}},abrupt:function(e,t){for(var n=this.tryEntries.length-1;n>=0;--n){var o=this.tryEntries[n];if(o.tryLoc<=this.prev&&r.call(o,"finallyLoc")&&this.prev<o.finallyLoc){var a=o;break}}a&&("break"===e||"continue"===e)&&a.tryLoc<=t&&t<=a.finallyLoc&&(a=null);var i=a?a.completion:{};return i.type=e,i.arg=t,a?(this.method="next",this.next=a.finallyLoc,l):this.complete(i)},complete:function(e,t){if("throw"===e.type)throw e.arg;return"break"===e.type||"continue"===e.type?this.next=e.arg:"return"===e.type?(this.rval=this.arg=e.arg,this.method="return",this.next="end"):"normal"===e.type&&t&&(this.next=t),l},finish:function(e){for(var t=this.tryEntries.length-1;t>=0;--t){var r=this.tryEntries[t];if(r.finallyLoc===e)return this.complete(r.completion,r.afterLoc),P(r),l}},catch:function(e){for(var t=this.tryEntries.length-1;t>=0;--t){var r=this.tryEntries[t];if(r.tryLoc===e){var n=r.completion;if("throw"===n.type){var o=n.arg;P(r)}return o}}throw new Error("illegal catch attempt")},delegateYield:function(e,t,r){return this.delegate={iterator:E(e),resultName:t,nextLoc:r},"next"===this.method&&(this.arg=void 0),l}},e}(e.exports);try{regeneratorRuntime=t}catch(e){"object"==typeof globalThis?globalThis.regeneratorRuntime=t:Function("r","regeneratorRuntime = r")(t)}})),f="You do not have permission to perform this operation. Login to get access or contact the app owner to get access.";function h(e,t){return d.apply(this,arguments)}function d(){return(d=c(p.mark((function e(r,n){var o;return p.wrap((function(e){for(;;)switch(e.prev=e.next){case 0:return o=g("__PLASMIC_EXECUTE_DATA_OP",v),e.next=3,t.wrapLoadingFetcher(o)(r,n);case 3:return e.abrupt("return",e.sent);case 5:case"end":return e.stop()}}),e)})))).apply(this,arguments)}function v(e,t){return y.apply(this,arguments)}function y(){return(y=c(p.mark((function e(t,r){var n,o,u,c;return p.wrap((function(e){for(;;)switch(e.prev=e.next){case 0:if(!t.roleId){e.next=4;break}if(null!=r&&r.user&&r.user.roleIds.includes(t.roleId)){e.next=4;break}throw console.error(f),new Error(f);case 4:return o=g("__PLASMIC_DATA_HOST","https://data.plasmic.app"),u=o+"/api/v1/server-data/sources/"+t.sourceId+"/execute",e.next=8,a(u,{method:"POST",headers:s({"Content-Type":"application/json"},(null==r?void 0:r.userAuthToken)&&{"x-plasmic-data-user-auth-token":r.userAuthToken}),body:i({opId:t.opId,userArgs:null!=(n=t.userArgs)?n:{},paginate:null==r?void 0:r.paginate})});case 8:if(200===(c=e.sent).status){e.next=14;break}return e.next=12,c.text();case 12:throw new Error(e.sent);case 14:return e.next=16,c.json();case 16:return e.abrupt("return",e.sent);case 17:case"end":return e.stop()}}),e)})))).apply(this,arguments)}function g(e,t){return"undefined"==typeof globalThis?t:null!=(r=globalThis[e])?r:t;var r}function m(e,t){var r=JSON.stringify({sourceId:e.sourceId,opId:e.opId,args:e.userArgs,userAuthToken:null==t?void 0:t.userAuthToken,paginate:null==t?void 0:t.paginate});return e.cacheKey?""+e.cacheKey+r:r}function x(e,t){return new Proxy({},{get:function(r,n){if("isPlasmicUndefinedDataProxy"===n)return!0;var o=e.fetchingPromise||t();throw o.plasmicType="PlasmicUndefinedDataError",o.message="Cannot read property "+String(n)+" - data is still loading",o}})}var w=+r.version.split(".")[0];function b(e,a){var i,u=n.usePlasmicDataSourceContext(),c=!(null==o.useDataEnv||null==(i=o.useDataEnv())||!i.plasmicInternalEnableLoadingBoundary),l=null==t.useSWRConfig?void 0:t.useSWRConfig(),p=null==l?void 0:l.cache,f=!e,d=f?null:m(e,{paginate:null==a?void 0:a.paginate,userAuthToken:null==u?void 0:u.userAuthToken}),v=r.useMemo((function(){return{fetchingPromise:void 0}}),[d]),y=r.useMemo((function(){return function(){if(v.fetchingPromise)return v.fetchingPromise;var t=h(e,{userAuthToken:(null==u?void 0:u.userAuthToken)||void 0,user:null==u?void 0:u.user,paginate:null==a?void 0:a.paginate});return v.fetchingPromise=t,t}}),[d,v]),g=r.useMemo((function(){return p?function(){if(v.fetchingPromise)return v.fetchingPromise;var e=y();return e.then((function(e){return p.set(d,e)})),e}:void 0}),[y,v,p]),b=t.useMutablePlasmicQueryData(d,y,{shouldRetryOnError:!1}),P=b.data,L=b.isLoading;return r.useMemo((function(){var e=s({},null!=P?P:{},function(e){for(var t={},r=arguments.length,n=new Array(r>1?r-1:0),o=1;o<r;o++)n[o-1]=arguments[o];for(var a=0,i=n;a<i.length;a++){var u=i[a];u in e&&(t[u]=e[u])}return t}(b,"isLoading","error"));return(null==a||!a.noUndefinedDataProxy)&&w>=18&&c&&g&&(L||f)&&void 0===e.data&&void 0===e.schema&&(e.data=x(v,g),e.schema=x(v,g)),e}),[f,P,b.error,L,null==a?void 0:a.noUndefinedDataProxy,c,v,g])}Object.defineProperty(exports,"usePlasmicDataConfig",{enumerable:!0,get:function(){return t.usePlasmicDataConfig}}),exports.Fetcher=function(e){var t,n=e.children,o=e.name,a=e.pageIndex,i=e.pageSize,u=b(e.dataOp,s({},!!a&&!!i&&{paginate:{pageIndex:a,pageSize:i}})),c=r.useMemo((function(){var t;return s({},e.queries,((t={})[null!=o?o:"data"]=u,t))}),[e.queries,o,u]);return null!=(t=null==n?void 0:n(c))?t:null},exports.FetcherMeta={name:"plasmic-data-source-fetcher",displayName:"Data Fetcher",props:{dataOp:{type:"dataSourceOp",displayName:"Data"},name:{type:"string",displayName:"Variable name"},children:{type:"slot",renderPropParams:["$queries"]},pageSize:{type:"number",advanced:!0,displayName:"Page size",description:"Only fetch in batches of this size; for pagination"},pageIndex:{type:"number",advanced:!0,displayName:"Page index",description:"0-based index of the paginated page to fetch"}},importPath:"@plasmicapp/react-web/lib/data-sources",importName:"Fetcher",alwaysAutoName:!0,styleSections:!1},exports.executePlasmicDataOp=h,exports.makeCacheKey=m,exports.useDependencyAwareQuery=function(e){var t,n,o=e.$queries,a=e.setDollarQueries,i=e.name,u=e.pageIndex,c=e.pageSize,l=b(function(e){try{return e()}catch(e){return}}(e.getDataOp),s({},!!u&&!!c&&{paginate:{pageIndex:u,pageSize:c}})),p=null!=i?i:"data",f=(t=p,n=r.useRef(void 0),r.useEffect((function(){return n.current=t,function(){n.current=void 0}})),n.current);r.useEffect((function(){if(!(p in o)||o[p]!==l){var e,t=s({},o,((e={})[p]=l,e));f&&p!==f&&f in o&&delete t[f],a(t)}}),[p,f,l,o,a])},exports.usePlasmicDataMutationOp=function(e){var t=null!=e?e:{},o=t.sourceId,a=t.opId,i=t.userArgs,u=n.usePlasmicDataSourceContext(),s=null==u?void 0:u.userAuthToken;return r.useCallback(c(p.mark((function e(){return p.wrap((function(e){for(;;)switch(e.prev=e.next){case 0:if(o&&a){e.next=2;break}return e.abrupt("return",void 0);case 2:return e.abrupt("return",h({sourceId:o,opId:a,userArgs:i},{userAuthToken:s||void 0,user:null==u?void 0:u.user}));case 3:case"end":return e.stop()}}),e)}))),[o,a,i,s])},exports.usePlasmicDataOp=b;
 //# sourceMappingURL=data-sources.cjs.production.min.js.map

dist/data-sources.esm.js

@@ -1,5 +0,6 @@
-import { wrapLoadingFetcher, useMutablePlasmicQueryData } from '@plasmicapp/query';
+import { wrapLoadingFetcher, useSWRConfig, useMutablePlasmicQueryData } from '@plasmicapp/query';
 export { usePlasmicDataConfig } from '@plasmicapp/query';
 import React from 'react';
 import { usePlasmicDataSourceContext } from '@plasmicapp/data-sources-context';
+import { useDataEnv } from '@plasmicapp/host';
 import fetch from '@plasmicapp/isomorphic-unfetch';
@@ -841,32 +842,68 @@ import stringify from 'fast-stringify';
 }
+var enableLoadingBoundaryKey = 'plasmicInternalEnableLoadingBoundary';
+function mkUndefinedDataProxy(promiseRef, fetchAndUpdateCache) {
+  return new Proxy({}, {
+    get: function get(_target, prop) {
+      if (prop === 'isPlasmicUndefinedDataProxy') {
+        return true;
+      }
+      var promise = promiseRef.fetchingPromise || fetchAndUpdateCache();
+      promise.plasmicType = 'PlasmicUndefinedDataError';
+      promise.message = "Cannot read property " + String(prop) + " - data is still loading";
+      throw promise;
+    }
+  });
+}
+var reactMajorVersion = + /*#__PURE__*/React.version.split('.')[0];
 function usePlasmicDataOp(dataOp, opts) {
+  var _ph$useDataEnv;
   var ctx = usePlasmicDataSourceContext();
-  var res = useMutablePlasmicQueryData(function () {
-    if (!dataOp) {
-      return null;
-    }
-    return makeCacheKey(dataOp, {
-      paginate: opts == null ? void 0 : opts.paginate,
-      userAuthToken: ctx == null ? void 0 : ctx.userAuthToken
-    });
-  }, /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee() {
-    return runtime_1.wrap(function _callee$(_context) {
-      while (1) {
-        switch (_context.prev = _context.next) {
-          case 0:
-            _context.next = 2;
-            return executePlasmicDataOp(dataOp, {
-              userAuthToken: (ctx == null ? void 0 : ctx.userAuthToken) || undefined,
-              user: ctx == null ? void 0 : ctx.user,
-              paginate: opts == null ? void 0 : opts.paginate
-            });
-          case 2:
-            return _context.abrupt("return", _context.sent);
-          case 3:
-          case "end":
-            return _context.stop();
-        }
+  var enableLoadingBoundary = !!(useDataEnv != null && (_ph$useDataEnv = useDataEnv()) != null && _ph$useDataEnv[enableLoadingBoundaryKey]);
+  // Check if `useSWRConfig` exists for backwards compatibility.
+  var config = useSWRConfig == null ? void 0 : useSWRConfig();
+  var cache = config == null ? void 0 : config.cache;
+  var isNullDataOp = !dataOp;
+  var key = isNullDataOp ? null : makeCacheKey(dataOp, {
+    paginate: opts == null ? void 0 : opts.paginate,
+    userAuthToken: ctx == null ? void 0 : ctx.userAuthToken
+  });
+  var fetchingData = React.useMemo(function () {
+    return {
+      fetchingPromise: undefined
+    };
+  }, [key]);
+  var fetcher = React.useMemo(function () {
+    return function () {
+      if (fetchingData.fetchingPromise) {
+        return fetchingData.fetchingPromise;
       }
-    }, _callee);
-  })), {
+      var fetcherFn = function fetcherFn() {
+        return (
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+          executePlasmicDataOp(dataOp, {
+            userAuthToken: (ctx == null ? void 0 : ctx.userAuthToken) || undefined,
+            user: ctx == null ? void 0 : ctx.user,
+            paginate: opts == null ? void 0 : opts.paginate
+          })
+        );
+      };
+      var fetcherPromise = fetcherFn();
+      fetchingData.fetchingPromise = fetcherPromise;
+      return fetcherPromise;
+    };
+  }, [key, fetchingData]);
+  var fetchAndUpdateCache = React.useMemo(function () {
+    return cache ? function () {
+      if (fetchingData.fetchingPromise) {
+        // No need to update cache as the exist promise call site will do it
+        return fetchingData.fetchingPromise;
+      }
+      var fetcherPromise = fetcher();
+      fetcherPromise.then(function (data) {
+        return cache.set(key, data);
+      });
+      return fetcherPromise;
+    } : undefined;
+  }, [fetcher, fetchingData, cache]);
+  var res = useMutablePlasmicQueryData(key, fetcher, {
     shouldRetryOnError: false
@@ -878,24 +915,29 @@ });
   return React.useMemo(function () {
-    return _extends({}, data != null ? data : {}, pick(res, 'isLoading', 'error'));
-  }, [data, error, isLoading]);
+    var result = _extends({}, data != null ? data : {}, pick(res, 'isLoading', 'error'));
+    if (!(opts != null && opts.noUndefinedDataProxy) && reactMajorVersion >= 18 && enableLoadingBoundary && fetchAndUpdateCache && (isLoading || isNullDataOp) && result.data === undefined && result.schema === undefined) {
+      result.data = mkUndefinedDataProxy(fetchingData, fetchAndUpdateCache);
+      result.schema = mkUndefinedDataProxy(fetchingData, fetchAndUpdateCache);
+    }
+    return result;
+  }, [isNullDataOp, data, error, isLoading, opts == null ? void 0 : opts.noUndefinedDataProxy, enableLoadingBoundary, fetchingData, fetchAndUpdateCache]);
 }
 function usePlasmicDataMutationOp(dataOp) {
-  var _ref2 = dataOp != null ? dataOp : {},
-    sourceId = _ref2.sourceId,
-    opId = _ref2.opId,
-    userArgs = _ref2.userArgs;
+  var _ref = dataOp != null ? dataOp : {},
+    sourceId = _ref.sourceId,
+    opId = _ref.opId,
+    userArgs = _ref.userArgs;
   var ctx = usePlasmicDataSourceContext();
   var userToken = ctx == null ? void 0 : ctx.userAuthToken;
-  return React.useCallback( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee2() {
-    return runtime_1.wrap(function _callee2$(_context2) {
+  return React.useCallback( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee() {
+    return runtime_1.wrap(function _callee$(_context) {
       while (1) {
-        switch (_context2.prev = _context2.next) {
+        switch (_context.prev = _context.next) {
           case 0:
             if (!(!sourceId || !opId)) {
-              _context2.next = 2;
+              _context.next = 2;
               break;
             }
-            return _context2.abrupt("return", undefined);
+            return _context.abrupt("return", undefined);
           case 2:
-            return _context2.abrupt("return", executePlasmicDataOp({
+            return _context.abrupt("return", executePlasmicDataOp({
               sourceId: sourceId,
@@ -910,6 +952,6 @@ opId: opId,
           case "end":
-            return _context2.stop();
+            return _context.stop();
         }
       }
-    }, _callee2);
+    }, _callee);
   })), [sourceId, opId, userArgs, userToken]);
@@ -982,2 +1024,5 @@ }
 }
+/**
+ * @deprecated Prefer using `usePlasmicDataOp` directly instead.
+ */
 function useDependencyAwareQuery(_ref) {
@@ -984,0 +1029,0 @@ var $queries = _ref.$queries,

dist/hooks/useDependencyAwareQuery.d.ts

@@ -8,2 +8,5 @@ import { DataOpConfig } from '../components/Fetcher';
 }
+/**
+ * @deprecated Prefer using `usePlasmicDataOp` directly instead.
+ */
 export declare function useDependencyAwareQuery({ $queries, getDataOp, setDollarQueries, name, pageIndex, pageSize, }: DependencyAwareQueryConfig): void;

dist/hooks/usePlasmicDataOp.d.ts

@@ -9,2 +9,3 @@ import { DataOp } from '../executor';
     paginate?: Pagination;
+    noUndefinedDataProxy?: boolean;
 }): Partial<T> & {
@@ -11,0 +12,0 @@ error?: E;

package.json

 {
-  "version": "0.1.86",
+  "version": "0.1.87",
   "license": "MIT",
@@ -61,5 +61,5 @@ "main": "dist/index.js",
     "@plasmicapp/data-sources-context": "0.1.11",
-    "@plasmicapp/host": "1.0.144",
+    "@plasmicapp/host": "1.0.145",
     "@plasmicapp/isomorphic-unfetch": "^1.0.1",
-    "@plasmicapp/query": "0.1.64",
+    "@plasmicapp/query": "0.1.65",
     "fast-stringify": "^2.0.0"
@@ -70,3 +70,3 @@ },
   },
-  "gitHead": "5f738407b3507b4cdcad7003b0d97593556a8702"
+  "gitHead": "fa865641d9193b8b0b6cf7f073688d9801d2e59c"
 }

No alert changes

Improved metrics

Total package byte prevSize

281078

increased by7.61%

Lines of code

2205

increased by4.6%

Dependency changes

• + Added@plasmicapp/host@1.0.145(transitive)

• + Added@plasmicapp/query@0.1.65(transitive)

• - Removed@plasmicapp/host@1.0.144(transitive)

• - Removed@plasmicapp/query@0.1.64(transitive)

• Updated@plasmicapp/host@1.0.145

• Updated@plasmicapp/query@0.1.65