@rest-hooks/endpoint - npm Package Compare versions

Comparing version 0.3.2 to 0.4.0

CHANGELOG.md

@@ -6,2 +6,14 @@ # Change Log
 
+## 0.4.0 (2020-07-14)
+
+* enhance: Resource uses endpoint (#365) ([4472106](https://github.com/coinbase/rest-hooks/commit/4472106)), closes [#365](https://github.com/coinbase/rest-hooks/issues/365)
+
+
+### BREAKING CHANGE
+
+* getFetchOptions() -> getEndpointExtra()
+
+
+
+
 ## <small>0.3.2 (2020-07-14)</small>
@@ -8,0 +20,0 @@

dist/index.cjs.js

@@ -121,2 +121,11 @@ 'use strict';
     _this.type = _this.sideEffect ? 'mutate' : 'read';
+    _this.options = Object.assign({}, options);
+    delete _this.options.key;
+    delete _this.options.schema;
+    delete _this.options.sideEffect;
+
+    if (Object.keys(_this.options).length === 0) {
+      delete _this.options;
+    }
+
     return _this;
@@ -134,3 +143,13 @@ }
 
-    var optionsToPass = Object.assign({}, this, options);
+    /** The following is for compatibility with FetchShape */
+    var optionsCopy = Object.assign({}, options);
+    delete optionsCopy.key;
+    delete optionsCopy.schema;
+    delete optionsCopy.sideEffect;
+    var optionsToPass = Object.assign({}, this, options, {
+      /** The following is for compatibility with FetchShape */
+      options: Object.assign({}, this.options, {
+        optionsCopy: optionsCopy
+      })
+    });
     return new this.constructor((_options$fetch = options.fetch) != null ? _options$fetch : this.fetch, optionsToPass);
@@ -137,0 +156,0 @@ }

dist/index.umd.min.js

@@ -1,1 +0,1 @@
-!function(t,e){"object"==typeof exports&&"undefined"!=typeof module?e(exports):"function"==typeof define&&define.amd?define(["exports"],e):e((t=t||self).restHookCore={})}(this,(function(t){"use strict";function e(t){return(e=Object.setPrototypeOf?Object.getPrototypeOf:function(t){return t.__proto__||Object.getPrototypeOf(t)})(t)}function n(t,e){return(n=Object.setPrototypeOf||function(t,e){return t.__proto__=e,t})(t,e)}function r(){if("undefined"==typeof Reflect||!Reflect.construct)return!1;if(Reflect.construct.sham)return!1;if("function"==typeof Proxy)return!0;try{return Date.prototype.toString.call(Reflect.construct(Date,[],(function(){}))),!0}catch(t){return!1}}function o(t,e,u){return(o=r()?Reflect.construct:function(t,e,r){var o=[null];o.push.apply(o,e);var u=new(Function.bind.apply(t,o));return r&&n(u,r.prototype),u}).apply(null,arguments)}function u(t){var r="function"==typeof Map?new Map:void 0;return(u=function(t){if(null===t||(u=t,-1===Function.toString.call(u).indexOf("[native code]")))return t;var u;if("function"!=typeof t)throw new TypeError("Super expression must either be null or a function");if(void 0!==r){if(r.has(t))return r.get(t);r.set(t,c)}function c(){return o(t,arguments,e(this).constructor)}return c.prototype=Object.create(t.prototype,{constructor:{value:c,enumerable:!1,writable:!0,configurable:!0}}),n(c,t)})(t)}var c=function(t){var e,n;function r(e,n){var r;return(r=t.call(this,"return arguments.callee.fetch.apply(arguments.callee, arguments)")||this).schema=null,r.getFetchKey=function(t){return r.key(t)},r.fetch=e,Object.assign(function(t){if(void 0===t)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return t}(r),n),r.type=r.sideEffect?"mutate":"read",r}n=t,(e=r).prototype=Object.create(n.prototype),e.prototype.constructor=e,e.__proto__=n;var o=r.prototype;return o.key=function(t){return this.fetch.name+" "+JSON.stringify(t)},o.extend=function(t){var e,n=Object.assign({},this,t);return new this.constructor(null!=(e=t.fetch)?e:this.fetch,n)},r}(u(Function)),i=function(){function t(t,e){this.schema=t,e&&(this.key=e)}return t.prototype.key=function(t){return JSON.stringify(t)},t}();t.Endpoint=c,t.Index=i,Object.defineProperty(t,"__esModule",{value:!0})}));
+!function(t,e){"object"==typeof exports&&"undefined"!=typeof module?e(exports):"function"==typeof define&&define.amd?define(["exports"],e):e((t=t||self).restHookCore={})}(this,(function(t){"use strict";function e(t){return(e=Object.setPrototypeOf?Object.getPrototypeOf:function(t){return t.__proto__||Object.getPrototypeOf(t)})(t)}function n(t,e){return(n=Object.setPrototypeOf||function(t,e){return t.__proto__=e,t})(t,e)}function o(){if("undefined"==typeof Reflect||!Reflect.construct)return!1;if(Reflect.construct.sham)return!1;if("function"==typeof Proxy)return!0;try{return Date.prototype.toString.call(Reflect.construct(Date,[],(function(){}))),!0}catch(t){return!1}}function r(t,e,i){return(r=o()?Reflect.construct:function(t,e,o){var r=[null];r.push.apply(r,e);var i=new(Function.bind.apply(t,r));return o&&n(i,o.prototype),i}).apply(null,arguments)}function i(t){var o="function"==typeof Map?new Map:void 0;return(i=function(t){if(null===t||(i=t,-1===Function.toString.call(i).indexOf("[native code]")))return t;var i;if("function"!=typeof t)throw new TypeError("Super expression must either be null or a function");if(void 0!==o){if(o.has(t))return o.get(t);o.set(t,c)}function c(){return r(t,arguments,e(this).constructor)}return c.prototype=Object.create(t.prototype,{constructor:{value:c,enumerable:!1,writable:!0,configurable:!0}}),n(c,t)})(t)}var c=function(t){var e,n;function o(e,n){var o;return(o=t.call(this,"return arguments.callee.fetch.apply(arguments.callee, arguments)")||this).schema=null,o.getFetchKey=function(t){return o.key(t)},o.fetch=e,Object.assign(function(t){if(void 0===t)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return t}(o),n),o.type=o.sideEffect?"mutate":"read",o.options=Object.assign({},n),delete o.options.key,delete o.options.schema,delete o.options.sideEffect,0===Object.keys(o.options).length&&delete o.options,o}n=t,(e=o).prototype=Object.create(n.prototype),e.prototype.constructor=e,e.__proto__=n;var r=o.prototype;return r.key=function(t){return this.fetch.name+" "+JSON.stringify(t)},r.extend=function(t){var e,n=Object.assign({},t);delete n.key,delete n.schema,delete n.sideEffect;var o=Object.assign({},this,t,{options:Object.assign({},this.options,{optionsCopy:n})});return new this.constructor(null!=(e=t.fetch)?e:this.fetch,o)},o}(i(Function)),u=function(){function t(t,e){this.schema=t,e&&(this.key=e)}return t.prototype.key=function(t){return JSON.stringify(t)},t}();t.Endpoint=c,t.Index=u,Object.defineProperty(t,"__esModule",{value:!0})}));

lib/endpoint.d.ts

@@ -124,3 +124,4 @@ /* eslint-disable @typescript-eslint/ban-types */
   readonly type: M extends undefined ? 'read' : 'mutate';
-  getFetchKey(...args: Parameters<F>): string;
+  getFetchKey(params: Parameters<F>[0]): string;
+  options?: EndpointExtraOptions;
 }
@@ -127,0 +128,0 @@

lib/endpoint.js

@@ -15,2 +15,10 @@ export default class Endpoint extends Function {
     this.type = this.sideEffect ? 'mutate' : 'read';
+    this.options = Object.assign({}, options);
+    delete this.options.key;
+    delete this.options.schema;
+    delete this.options.sideEffect;
+
+    if (Object.keys(this.options).length === 0) {
+      delete this.options;
+    }
   }
@@ -25,3 +33,13 @@
 
-    const optionsToPass = Object.assign({}, this, options);
+    /** The following is for compatibility with FetchShape */
+    const optionsCopy = Object.assign({}, options);
+    delete optionsCopy.key;
+    delete optionsCopy.schema;
+    delete optionsCopy.sideEffect;
+    const optionsToPass = Object.assign({}, this, options, {
+      /** The following is for compatibility with FetchShape */
+      options: Object.assign({}, this.options, {
+        optionsCopy
+      })
+    });
     return new this.constructor((_options$fetch = options.fetch) != null ? _options$fetch : this.fetch, optionsToPass);
@@ -33,2 +51,2 @@ }
 }
-//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uL3NyYy9lbmRwb2ludC5qcyJdLCJuYW1lcyI6WyJFbmRwb2ludCIsIkZ1bmN0aW9uIiwiY29uc3RydWN0b3IiLCJmZXRjaEZ1bmN0aW9uIiwib3B0aW9ucyIsInNjaGVtYSIsImdldEZldGNoS2V5IiwicGFyYW1zIiwia2V5IiwiZmV0Y2giLCJPYmplY3QiLCJhc3NpZ24iLCJ0eXBlIiwic2lkZUVmZmVjdCIsIm5hbWUiLCJKU09OIiwic3RyaW5naWZ5IiwiZXh0ZW5kIiwib3B0aW9uc1RvUGFzcyJdLCJtYXBwaW5ncyI6IkFBQUEsZUFBZSxNQUFNQSxRQUFOLFNBQXVCQyxRQUF2QixDQUFnQztBQUM3Q0MsRUFBQUEsV0FBVyxDQUFDQyxhQUFELEVBQWdCQyxPQUFoQixFQUF5QjtBQUNsQyxVQUFNLGtFQUFOO0FBRGtDLFNBcUJwQ0MsTUFyQm9DLEdBcUIzQixJQXJCMkI7O0FBQUEsU0FzQnBDQyxXQXRCb0MsR0FzQnRCQyxNQUFNLElBQUk7QUFDdEIsYUFBTyxLQUFLQyxHQUFMLENBQVNELE1BQVQsQ0FBUDtBQUNELEtBeEJtQzs7QUFFbEMsU0FBS0UsS0FBTCxHQUFhTixhQUFiO0FBQ0FPLElBQUFBLE1BQU0sQ0FBQ0MsTUFBUCxDQUFjLElBQWQsRUFBb0JQLE9BQXBCO0FBQ0E7O0FBQ0EsU0FBS1EsSUFBTCxHQUFZLEtBQUtDLFVBQUwsR0FBa0IsUUFBbEIsR0FBNkIsTUFBekM7QUFDRDs7QUFFREwsRUFBQUEsR0FBRyxDQUFDRCxNQUFELEVBQVM7QUFDVixXQUFRLEdBQUUsS0FBS0UsS0FBTCxDQUFXSyxJQUFLLElBQUdDLElBQUksQ0FBQ0MsU0FBTCxDQUFlVCxNQUFmLENBQXVCLEVBQXBEO0FBQ0Q7O0FBRURVLEVBQUFBLE1BQU0sQ0FBQ2IsT0FBRCxFQUFVO0FBQUE7O0FBQ2QsVUFBTWMsYUFBYSxxQkFDZCxJQURjLEVBRWRkLE9BRmMsQ0FBbkI7QUFJQSxXQUFPLElBQUksS0FBS0YsV0FBVCxtQkFBcUJFLE9BQU8sQ0FBQ0ssS0FBN0IsNkJBQXNDLEtBQUtBLEtBQTNDLEVBQWtEUyxhQUFsRCxDQUFQO0FBQ0Q7QUFFRDs7O0FBckI2QyIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCBkZWZhdWx0IGNsYXNzIEVuZHBvaW50IGV4dGVuZHMgRnVuY3Rpb24ge1xuICBjb25zdHJ1Y3RvcihmZXRjaEZ1bmN0aW9uLCBvcHRpb25zKSB7XG4gICAgc3VwZXIoJ3JldHVybiBhcmd1bWVudHMuY2FsbGVlLmZldGNoLmFwcGx5KGFyZ3VtZW50cy5jYWxsZWUsIGFyZ3VtZW50cyknKTtcbiAgICB0aGlzLmZldGNoID0gZmV0Y2hGdW5jdGlvbjtcbiAgICBPYmplY3QuYXNzaWduKHRoaXMsIG9wdGlvbnMpO1xuICAgIC8qKiBUaGUgZm9sbG93aW5nIGlzIGZvciBjb21wYXRpYmlsaXR5IHdpdGggRmV0Y2hTaGFwZSAqL1xuICAgIHRoaXMudHlwZSA9IHRoaXMuc2lkZUVmZmVjdCA/ICdtdXRhdGUnIDogJ3JlYWQnO1xuICB9XG5cbiAga2V5KHBhcmFtcykge1xuICAgIHJldHVybiBgJHt0aGlzLmZldGNoLm5hbWV9ICR7SlNPTi5zdHJpbmdpZnkocGFyYW1zKX1gO1xuICB9XG5cbiAgZXh0ZW5kKG9wdGlvbnMpIHtcbiAgICBjb25zdCBvcHRpb25zVG9QYXNzID0ge1xuICAgICAgLi4udGhpcyxcbiAgICAgIC4uLm9wdGlvbnMsXG4gICAgfTtcbiAgICByZXR1cm4gbmV3IHRoaXMuY29uc3RydWN0b3Iob3B0aW9ucy5mZXRjaCA/PyB0aGlzLmZldGNoLCBvcHRpb25zVG9QYXNzKTtcbiAgfVxuXG4gIC8qKiBUaGUgZm9sbG93aW5nIGlzIGZvciBjb21wYXRpYmlsaXR5IHdpdGggRmV0Y2hTaGFwZSAqL1xuICBzY2hlbWEgPSBudWxsO1xuICBnZXRGZXRjaEtleSA9IHBhcmFtcyA9PiB7XG4gICAgcmV0dXJuIHRoaXMua2V5KHBhcmFtcyk7XG4gIH07XG59XG4iXX0=
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uL3NyYy9lbmRwb2ludC5qcyJdLCJuYW1lcyI6WyJFbmRwb2ludCIsIkZ1bmN0aW9uIiwiY29uc3RydWN0b3IiLCJmZXRjaEZ1bmN0aW9uIiwib3B0aW9ucyIsInNjaGVtYSIsImdldEZldGNoS2V5IiwicGFyYW1zIiwia2V5IiwiZmV0Y2giLCJPYmplY3QiLCJhc3NpZ24iLCJ0eXBlIiwic2lkZUVmZmVjdCIsImtleXMiLCJsZW5ndGgiLCJuYW1lIiwiSlNPTiIsInN0cmluZ2lmeSIsImV4dGVuZCIsIm9wdGlvbnNDb3B5Iiwib3B0aW9uc1RvUGFzcyJdLCJtYXBwaW5ncyI6IkFBQUEsZUFBZSxNQUFNQSxRQUFOLFNBQXVCQyxRQUF2QixDQUFnQztBQUM3Q0MsRUFBQUEsV0FBVyxDQUFDQyxhQUFELEVBQWdCQyxPQUFoQixFQUF5QjtBQUNsQyxVQUFNLGtFQUFOO0FBRGtDLFNBdUNwQ0MsTUF2Q29DLEdBdUMzQixJQXZDMkI7O0FBQUEsU0F3Q3BDQyxXQXhDb0MsR0F3Q3RCQyxNQUFNLElBQUk7QUFDdEIsYUFBTyxLQUFLQyxHQUFMLENBQVNELE1BQVQsQ0FBUDtBQUNELEtBMUNtQzs7QUFFbEMsU0FBS0UsS0FBTCxHQUFhTixhQUFiO0FBQ0FPLElBQUFBLE1BQU0sQ0FBQ0MsTUFBUCxDQUFjLElBQWQsRUFBb0JQLE9BQXBCO0FBQ0E7O0FBQ0EsU0FBS1EsSUFBTCxHQUFZLEtBQUtDLFVBQUwsR0FBa0IsUUFBbEIsR0FBNkIsTUFBekM7QUFDQSxTQUFLVCxPQUFMLHFCQUFvQkEsT0FBcEI7QUFDQSxXQUFPLEtBQUtBLE9BQUwsQ0FBYUksR0FBcEI7QUFDQSxXQUFPLEtBQUtKLE9BQUwsQ0FBYUMsTUFBcEI7QUFDQSxXQUFPLEtBQUtELE9BQUwsQ0FBYVMsVUFBcEI7O0FBQ0EsUUFBSUgsTUFBTSxDQUFDSSxJQUFQLENBQVksS0FBS1YsT0FBakIsRUFBMEJXLE1BQTFCLEtBQXFDLENBQXpDLEVBQTRDO0FBQzFDLGFBQU8sS0FBS1gsT0FBWjtBQUNEO0FBQ0Y7O0FBRURJLEVBQUFBLEdBQUcsQ0FBQ0QsTUFBRCxFQUFTO0FBQ1YsV0FBUSxHQUFFLEtBQUtFLEtBQUwsQ0FBV08sSUFBSyxJQUFHQyxJQUFJLENBQUNDLFNBQUwsQ0FBZVgsTUFBZixDQUF1QixFQUFwRDtBQUNEOztBQUVEWSxFQUFBQSxNQUFNLENBQUNmLE9BQUQsRUFBVTtBQUFBOztBQUNkO0FBQ0EsVUFBTWdCLFdBQVcscUJBQVFoQixPQUFSLENBQWpCO0FBQ0EsV0FBT2dCLFdBQVcsQ0FBQ1osR0FBbkI7QUFDQSxXQUFPWSxXQUFXLENBQUNmLE1BQW5CO0FBQ0EsV0FBT2UsV0FBVyxDQUFDUCxVQUFuQjtBQUVBLFVBQU1RLGFBQWEscUJBQ2QsSUFEYyxFQUVkakIsT0FGYztBQUdqQjtBQUNBQSxNQUFBQSxPQUFPLG9CQUNGLEtBQUtBLE9BREg7QUFFTGdCLFFBQUFBO0FBRks7QUFKVSxNQUFuQjtBQVNBLFdBQU8sSUFBSSxLQUFLbEIsV0FBVCxtQkFBcUJFLE9BQU8sQ0FBQ0ssS0FBN0IsNkJBQXNDLEtBQUtBLEtBQTNDLEVBQWtEWSxhQUFsRCxDQUFQO0FBQ0Q7QUFFRDs7O0FBdkM2QyIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCBkZWZhdWx0IGNsYXNzIEVuZHBvaW50IGV4dGVuZHMgRnVuY3Rpb24ge1xuICBjb25zdHJ1Y3RvcihmZXRjaEZ1bmN0aW9uLCBvcHRpb25zKSB7XG4gICAgc3VwZXIoJ3JldHVybiBhcmd1bWVudHMuY2FsbGVlLmZldGNoLmFwcGx5KGFyZ3VtZW50cy5jYWxsZWUsIGFyZ3VtZW50cyknKTtcbiAgICB0aGlzLmZldGNoID0gZmV0Y2hGdW5jdGlvbjtcbiAgICBPYmplY3QuYXNzaWduKHRoaXMsIG9wdGlvbnMpO1xuICAgIC8qKiBUaGUgZm9sbG93aW5nIGlzIGZvciBjb21wYXRpYmlsaXR5IHdpdGggRmV0Y2hTaGFwZSAqL1xuICAgIHRoaXMudHlwZSA9IHRoaXMuc2lkZUVmZmVjdCA/ICdtdXRhdGUnIDogJ3JlYWQnO1xuICAgIHRoaXMub3B0aW9ucyA9IHsgLi4ub3B0aW9ucyB9O1xuICAgIGRlbGV0ZSB0aGlzLm9wdGlvbnMua2V5O1xuICAgIGRlbGV0ZSB0aGlzLm9wdGlvbnMuc2NoZW1hO1xuICAgIGRlbGV0ZSB0aGlzLm9wdGlvbnMuc2lkZUVmZmVjdDtcbiAgICBpZiAoT2JqZWN0LmtleXModGhpcy5vcHRpb25zKS5sZW5ndGggPT09IDApIHtcbiAgICAgIGRlbGV0ZSB0aGlzLm9wdGlvbnM7XG4gICAgfVxuICB9XG5cbiAga2V5KHBhcmFtcykge1xuICAgIHJldHVybiBgJHt0aGlzLmZldGNoLm5hbWV9ICR7SlNPTi5zdHJpbmdpZnkocGFyYW1zKX1gO1xuICB9XG5cbiAgZXh0ZW5kKG9wdGlvbnMpIHtcbiAgICAvKiogVGhlIGZvbGxvd2luZyBpcyBmb3IgY29tcGF0aWJpbGl0eSB3aXRoIEZldGNoU2hhcGUgKi9cbiAgICBjb25zdCBvcHRpb25zQ29weSA9IHsgLi4ub3B0aW9ucyB9O1xuICAgIGRlbGV0ZSBvcHRpb25zQ29weS5rZXk7XG4gICAgZGVsZXRlIG9wdGlvbnNDb3B5LnNjaGVtYTtcbiAgICBkZWxldGUgb3B0aW9uc0NvcHkuc2lkZUVmZmVjdDtcblxuICAgIGNvbnN0IG9wdGlvbnNUb1Bhc3MgPSB7XG4gICAgICAuLi50aGlzLFxuICAgICAgLi4ub3B0aW9ucyxcbiAgICAgIC8qKiBUaGUgZm9sbG93aW5nIGlzIGZvciBjb21wYXRpYmlsaXR5IHdpdGggRmV0Y2hTaGFwZSAqL1xuICAgICAgb3B0aW9uczoge1xuICAgICAgICAuLi50aGlzLm9wdGlvbnMsXG4gICAgICAgIG9wdGlvbnNDb3B5LFxuICAgICAgfSxcbiAgICB9O1xuICAgIHJldHVybiBuZXcgdGhpcy5jb25zdHJ1Y3RvcihvcHRpb25zLmZldGNoID8/IHRoaXMuZmV0Y2gsIG9wdGlvbnNUb1Bhc3MpO1xuICB9XG5cbiAgLyoqIFRoZSBmb2xsb3dpbmcgaXMgZm9yIGNvbXBhdGliaWxpdHkgd2l0aCBGZXRjaFNoYXBlICovXG4gIHNjaGVtYSA9IG51bGw7XG4gIGdldEZldGNoS2V5ID0gcGFyYW1zID0+IHtcbiAgICByZXR1cm4gdGhpcy5rZXkocGFyYW1zKTtcbiAgfTtcbn1cbiJdfQ==

lib/index.d.ts

 export type { EndpointInterface, ReadEndpoint, MutateEndpoint, IndexInterface, IndexParams, ArrayElement, } from './interface';
-export type { EndpointOptions } from './endpoint';
+export type { EndpointOptions, EndpointInstance, ExtendEndpoint, } from './endpoint';
 export type { EndpointExtraOptions, FetchFunction, OptimisticUpdateParams, UpdateFunction, } from './types';
-export type { ResolveType, InferReturn } from './utility';
+export type { ResolveType, EndpointParam, InferReturn } from './utility';
 export { default as Endpoint } from './endpoint';
 export { default as Index } from './indexEndpoint';
 //# sourceMappingURL=index.d.ts.map

lib/indexEndpoint.d.ts

@@ -1,8 +0,8 @@
-import { Entity } from '@rest-hooks/normalizr';
+import { Schema } from '@rest-hooks/normalizr';
 import type { IndexInterface, IndexParams } from './interface';
-export default class Index<E extends typeof Entity> implements IndexInterface<E> {
-    schema: E;
-    constructor(entity: E);
-    key(params?: Readonly<IndexParams<E>>): string;
+export default class Index<S extends Schema, P = Readonly<IndexParams<S>>> implements IndexInterface<S, P> {
+    schema: S;
+    constructor(schema: S, key?: (params: P) => string);
+    key(params?: P): string;
 }
 //# sourceMappingURL=indexEndpoint.d.ts.map

lib/interface.d.ts

@@ -1,6 +0,6 @@
-import { Schema, Entity } from '@rest-hooks/normalizr';
+import { Schema, AbstractInstanceType } from '@rest-hooks/normalizr';
 import type { EndpointExtraOptions, FetchFunction } from './types';
 import { InferReturn } from './utility';
 /** Defines a networking endpoint */
-export interface EndpointInterface<F extends (params?: any, body?: any) => Promise<any> = FetchFunction, S extends Schema | undefined = undefined, M extends true | undefined = undefined> extends EndpointExtraOptions {
+export interface EndpointInterface<F extends FetchFunction = FetchFunction, S extends Schema | undefined = Schema | undefined, M extends true | undefined = true | undefined> extends EndpointExtraOptions {
     (...args: Parameters<F>): InferReturn<F, S>;
@@ -12,17 +12,17 @@ key(parmas?: Readonly<Parameters<F>[0]>): string;
 /** To change values on the server */
-export interface MutateEndpoint<F extends (params?: any, body?: any) => Promise<any> = FetchFunction, S extends Schema | undefined = undefined> extends EndpointInterface<F, S, true> {
-    fetch(params: Readonly<Parameters<F>[0]>, body: Readonly<Parameters<F>[1]>): ReturnType<F>;
+export interface MutateEndpoint<F extends (params?: any, body?: any) => Promise<any> = FetchFunction, S extends Schema | undefined = Schema | undefined> extends EndpointInterface<F, S, true> {
+    sideEffect: true;
 }
 /** For retrieval requests */
-export interface ReadEndpoint<F extends (params?: any) => Promise<any> = FetchFunction, S extends Schema | undefined = undefined> extends EndpointInterface<F, S> {
-    fetch(params: Readonly<Parameters<F>[0]>): ReturnType<F>;
-}
+export declare type ReadEndpoint<F extends (params?: any) => Promise<any> = (params?: any) => Promise<any>, S extends Schema | undefined = Schema | undefined> = EndpointInterface<F, S, undefined>;
 export declare type ArrayElement<ArrayType extends unknown[] | readonly unknown[]> = ArrayType[number];
-export declare type IndexParams<E extends typeof Entity> = {
-    [K in Extract<ArrayElement<Exclude<E['indexes'], undefined>>, keyof E>]?: E[K];
-};
-export interface IndexInterface<S extends typeof Entity> {
-    key(params?: Readonly<IndexParams<S>>): string;
+export declare type IndexParams<S extends Schema> = S extends {
+    indexes: readonly string[];
+} ? {
+    [K in Extract<ArrayElement<S['indexes']>, keyof AbstractInstanceType<S>>]?: AbstractInstanceType<S>[K];
+} : Readonly<object>;
+export interface IndexInterface<S extends Schema = Schema, P = object> {
+    key(params?: P): string;
     readonly schema: S;
 }
 //# sourceMappingURL=interface.d.ts.map

lib/types.d.ts

@@ -17,5 +17,5 @@ import { Schema, Normalize } from '@rest-hooks/normalizr';
 }
-export declare type FetchFunction<P = any> = (params?: P, body?: any) => Promise<any>;
+export declare type FetchFunction<P = any, B = any, R = any> = (params?: P, body?: B) => Promise<R>;
 export declare type OptimisticUpdateParams<SourceSchema extends Schema, Dest extends EndpointInterface<FetchFunction, Schema, any>> = [Dest, Parameters<Dest>[0], UpdateFunction<SourceSchema, Exclude<Dest['schema'], undefined>>];
 export declare type UpdateFunction<SourceSchema extends Schema, DestSchema extends Schema> = (sourceResults: Normalize<SourceSchema>, destResults: Normalize<DestSchema> | undefined) => Normalize<DestSchema>;
 //# sourceMappingURL=types.d.ts.map

lib/utility.d.ts

 import { Denormalize, Schema } from '@rest-hooks/normalizr';
-import { EndpointInterface } from './interface';
 import { FetchFunction } from './types';
 /** What the function's promise resolves to */
-export declare type ResolveType<E extends EndpointInterface<any, any, any>> = ReturnType<E> extends Promise<infer R> ? R : never;
+export declare type ResolveType<E extends (...args: any) => any> = ReturnType<E> extends Promise<infer R> ? R : never;
 /** Fallback to schema if fetch function isn't defined */
 export declare type InferReturn<F extends FetchFunction, S extends Schema | undefined> = S extends undefined ? ReturnType<F> : ReturnType<F> extends unknown ? Promise<Denormalize<S>> : ReturnType<F>;
+/** Get the Params type for a given Shape */
+export declare type EndpointParam<E> = E extends (first: infer A, ...rest: any) => any ? A : E extends {
+    key: (first: infer A, ...rest: any) => any;
+} ? A : never;
 //# sourceMappingURL=utility.d.ts.map

package.json

 {
   "name": "@rest-hooks/endpoint",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "description": "Declarative Network Interface Definitions",
@@ -57,3 +57,3 @@ "sideEffects": false,
   },
-  "gitHead": "d0ab94539fe03f3366e2abf0cd206b19a2bee876"
+  "gitHead": "6e9b8b0c92bb84fce92ec809bf0235053000ce1b"
 }

src/endpoint.d.ts

@@ -124,3 +124,4 @@ /* eslint-disable @typescript-eslint/ban-types */
   readonly type: M extends undefined ? 'read' : 'mutate';
-  getFetchKey(...args: Parameters<F>): string;
+  getFetchKey(params: Parameters<F>[0]): string;
+  options?: EndpointExtraOptions;
 }
@@ -127,0 +128,0 @@

src/endpoint.js

@@ -8,2 +8,9 @@ export default class Endpoint extends Function {
     this.type = this.sideEffect ? 'mutate' : 'read';
+    this.options = { ...options };
+    delete this.options.key;
+    delete this.options.schema;
+    delete this.options.sideEffect;
+    if (Object.keys(this.options).length === 0) {
+      delete this.options;
+    }
   }
@@ -16,5 +23,16 @@
   extend(options) {
+    /** The following is for compatibility with FetchShape */
+    const optionsCopy = { ...options };
+    delete optionsCopy.key;
+    delete optionsCopy.schema;
+    delete optionsCopy.sideEffect;
+
     const optionsToPass = {
       ...this,
       ...options,
+      /** The following is for compatibility with FetchShape */
+      options: {
+        ...this.options,
+        optionsCopy,
+      },
     };
@@ -21,0 +39,0 @@ return new this.constructor(options.fetch ?? this.fetch, optionsToPass);

No alert changes

Improved metrics

Total package byte prevSize

71398

increased by6.17%

Lines of code

1004

increased by6.02%

No dependency changes