@data-client/rest 0.12.6 → 0.12.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.umd.min.js +1 -1
- package/legacy/NetworkError.js +1 -1
- package/legacy/RestEndpoint.js +1 -1
- package/legacy/RestEndpointTypes.js +1 -1
- package/legacy/RestHelpers.js +1 -1
- package/legacy/createResource.js +1 -1
- package/legacy/hookifyResource.js +1 -1
- package/legacy/next/index.js +1 -1
- package/legacy/paginatedCollections.js +1 -1
- package/legacy/resourceTypes.js +1 -1
- package/lib/NetworkError.js +1 -1
- package/lib/RestEndpoint.js +1 -1
- package/lib/RestEndpointTypes.d.ts +27 -4
- package/lib/RestEndpointTypes.d.ts.map +1 -1
- package/lib/RestEndpointTypes.js +1 -1
- package/lib/RestHelpers.js +1 -1
- package/lib/createResource.js +1 -1
- package/lib/hookifyResource.js +1 -1
- package/lib/next/index.js +1 -1
- package/lib/paginatedCollections.js +1 -1
- package/lib/resourceTypes.d.ts +6 -3
- package/lib/resourceTypes.d.ts.map +1 -1
- package/lib/resourceTypes.js +1 -1
- package/package.json +2 -2
- package/src/RestEndpointTypes.ts +27 -4
- package/src/__tests__/createResource.test.ts +2 -4
- package/src/resourceTypes.ts +6 -3
- package/ts4.0/RestEndpointTypes.d.ts +27 -4
- package/ts4.0/resourceTypes.d.ts +6 -3
- package/ts4.1/RestEndpointTypes.d.ts +27 -4
- package/ts4.1/resourceTypes.d.ts +6 -3
package/lib/hookifyResource.js
CHANGED
|
@@ -21,4 +21,4 @@ export default function hookifyResource(resource, useRequestInit) {
|
|
|
21
21
|
function capitalizeFirstLetter(s) {
|
|
22
22
|
return s.charAt(0).toUpperCase() + s.slice(1);
|
|
23
23
|
}
|
|
24
|
-
//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJuYW1lcyI6WyJob29raWZ5UmVzb3VyY2UiLCJyZXNvdXJjZSIsInVzZVJlcXVlc3RJbml0IiwidXNpbmdSZXNvdXJjZSIsIk9iamVjdCIsImtleXMiLCJmb3JFYWNoIiwia2V5IiwiZW5kcG9pbnQiLCJleHRlbmQiLCJ1bmRlZmluZWQiLCJjYXBpdGFsaXplRmlyc3RMZXR0ZXIiLCJyZXF1ZXN0SW5pdCIsInMiLCJjaGFyQXQiLCJ0b1VwcGVyQ2FzZSIsInNsaWNlIl0sInNvdXJjZXMiOlsiLi4vc3JjL2hvb2tpZnlSZXNvdXJjZS50cyJdLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBFbmRwb2ludEludGVyZmFjZSB9IGZyb20gJ0BkYXRhLWNsaWVudC9lbmRwb2ludCc7XG5cbmV4cG9ydCBpbnRlcmZhY2UgSG9va2FibGVFbmRwb2ludEludGVyZmFjZSBleHRlbmRzIEVuZHBvaW50SW50ZXJmYWNlIHtcbiAgZXh0ZW5kKC4uLmFyZ3M6IGFueSk6IEhvb2thYmxlRW5kcG9pbnRJbnRlcmZhY2U7XG59XG5cbi8qKiBUdXJucyBhIGNvbGxlY3Rpb24gb2YgRW5kcG9pbnRzIChSZXNvdXJjZSkgaW50byBhIGNvbGxlY3Rpb24gb2YgaG9va3MuXG4gKiBUaGlzIGlzIHVzZWZ1bCBmb3IgRW5kcG9pbnRzIHRoYXQgbmVlZCBob29rcyB0byBwcmVwYXJlIHRoZWlyIGZldGNoIHJlcXVlc3RzLlxuICpcbiAqIEBzZWUgaHR0cHM6Ly9kYXRhY2xpZW50LmlvL3Jlc3QvYXBpL2hvb2tpZnlSZXNvdXJjZVxuICovXG5leHBvcnQgZGVmYXVsdCBmdW5jdGlvbiBob29raWZ5UmVzb3VyY2U8UiBleHRlbmRzIHt9PihcbiAgcmVzb3VyY2U6IFIsXG4gIHVzZVJlcXVlc3RJbml0OiAoKSA9PiBSZXF1ZXN0SW5pdCxcbik6IEhvb2tSZXNvdXJjZTxSPiB7XG4gIGNvbnN0IHVzaW5nUmVzb3VyY2U6IFJlY29yZDxzdHJpbmcsICgpID0+IEhvb2thYmxlRW5kcG9pbnRJbnRlcmZhY2U+ID0ge307XG4gIE9iamVjdC5rZXlzKHJlc291cmNlKS5mb3JFYWNoKGtleSA9PiB7XG4gICAgY29uc3QgZW5kcG9pbnQgPSAocmVzb3VyY2UgYXMgYW55KVtrZXldO1xuICAgIGlmIChlbmRwb2ludC5leHRlbmQgIT09IHVuZGVmaW5lZClcbiAgICAgIHVzaW5nUmVzb3VyY2VbYHVzZSR7Y2FwaXRhbGl6ZUZpcnN0TGV0dGVyKGtleSl9YF0gPSAoKSA9PiB7XG4gICAgICAgIC8vIHRoaXMgaXMgZmFsc2UgcG9zaXRpdmUgZHVlIHRvIHRoZSBkeW5hbWljIG5hdHVyZSBvZiBhc3NpZ25tZW50XG4gICAgICAgIC8vIGVzbGludC1kaXNhYmxlLW5leHQtbGluZSByZWFjdC1ob29rcy9ydWxlcy1vZi1ob29rc1xuICAgICAgICBjb25zdCByZXF1ZXN0SW5pdCA9IHVzZVJlcXVlc3RJbml0KCk7XG4gICAgICAgIHJldHVybiBlbmRwb2ludC5leHRlbmQoeyByZXF1ZXN0SW5pdCB9KTtcbiAgICAgIH07XG4gIH0pO1xuICByZXR1cm4gdXNpbmdSZXNvdXJjZSBhcyBhbnk7XG59XG5cbmV4cG9ydCB0eXBlIEhvb2tSZXNvdXJjZTxSIGV4dGVuZHMge30+
|
|
24
|
+
//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJuYW1lcyI6WyJob29raWZ5UmVzb3VyY2UiLCJyZXNvdXJjZSIsInVzZVJlcXVlc3RJbml0IiwidXNpbmdSZXNvdXJjZSIsIk9iamVjdCIsImtleXMiLCJmb3JFYWNoIiwia2V5IiwiZW5kcG9pbnQiLCJleHRlbmQiLCJ1bmRlZmluZWQiLCJjYXBpdGFsaXplRmlyc3RMZXR0ZXIiLCJyZXF1ZXN0SW5pdCIsInMiLCJjaGFyQXQiLCJ0b1VwcGVyQ2FzZSIsInNsaWNlIl0sInNvdXJjZXMiOlsiLi4vc3JjL2hvb2tpZnlSZXNvdXJjZS50cyJdLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBFbmRwb2ludEludGVyZmFjZSB9IGZyb20gJ0BkYXRhLWNsaWVudC9lbmRwb2ludCc7XG5cbmV4cG9ydCBpbnRlcmZhY2UgSG9va2FibGVFbmRwb2ludEludGVyZmFjZSBleHRlbmRzIEVuZHBvaW50SW50ZXJmYWNlIHtcbiAgZXh0ZW5kKC4uLmFyZ3M6IGFueSk6IEhvb2thYmxlRW5kcG9pbnRJbnRlcmZhY2U7XG59XG5cbi8qKiBUdXJucyBhIGNvbGxlY3Rpb24gb2YgRW5kcG9pbnRzIChSZXNvdXJjZSkgaW50byBhIGNvbGxlY3Rpb24gb2YgaG9va3MuXG4gKiBUaGlzIGlzIHVzZWZ1bCBmb3IgRW5kcG9pbnRzIHRoYXQgbmVlZCBob29rcyB0byBwcmVwYXJlIHRoZWlyIGZldGNoIHJlcXVlc3RzLlxuICpcbiAqIEBzZWUgaHR0cHM6Ly9kYXRhY2xpZW50LmlvL3Jlc3QvYXBpL2hvb2tpZnlSZXNvdXJjZVxuICovXG5leHBvcnQgZGVmYXVsdCBmdW5jdGlvbiBob29raWZ5UmVzb3VyY2U8UiBleHRlbmRzIHt9PihcbiAgcmVzb3VyY2U6IFIsXG4gIHVzZVJlcXVlc3RJbml0OiAoKSA9PiBSZXF1ZXN0SW5pdCxcbik6IEhvb2tSZXNvdXJjZTxSPiB7XG4gIGNvbnN0IHVzaW5nUmVzb3VyY2U6IFJlY29yZDxzdHJpbmcsICgpID0+IEhvb2thYmxlRW5kcG9pbnRJbnRlcmZhY2U+ID0ge307XG4gIE9iamVjdC5rZXlzKHJlc291cmNlKS5mb3JFYWNoKGtleSA9PiB7XG4gICAgY29uc3QgZW5kcG9pbnQgPSAocmVzb3VyY2UgYXMgYW55KVtrZXldO1xuICAgIGlmIChlbmRwb2ludC5leHRlbmQgIT09IHVuZGVmaW5lZClcbiAgICAgIHVzaW5nUmVzb3VyY2VbYHVzZSR7Y2FwaXRhbGl6ZUZpcnN0TGV0dGVyKGtleSl9YF0gPSAoKSA9PiB7XG4gICAgICAgIC8vIHRoaXMgaXMgZmFsc2UgcG9zaXRpdmUgZHVlIHRvIHRoZSBkeW5hbWljIG5hdHVyZSBvZiBhc3NpZ25tZW50XG4gICAgICAgIC8vIGVzbGludC1kaXNhYmxlLW5leHQtbGluZSByZWFjdC1ob29rcy9ydWxlcy1vZi1ob29rc1xuICAgICAgICBjb25zdCByZXF1ZXN0SW5pdCA9IHVzZVJlcXVlc3RJbml0KCk7XG4gICAgICAgIHJldHVybiBlbmRwb2ludC5leHRlbmQoeyByZXF1ZXN0SW5pdCB9KTtcbiAgICAgIH07XG4gIH0pO1xuICByZXR1cm4gdXNpbmdSZXNvdXJjZSBhcyBhbnk7XG59XG5cbmV4cG9ydCB0eXBlIEhvb2tSZXNvdXJjZTxSIGV4dGVuZHMge30+ID0ge1xuICBbSyBpbiBFeHRyYWN0PGtleW9mIFIsIHN0cmluZz4gYXMgYHVzZSR7Q2FwaXRhbGl6ZTxLPn1gXTogKCkgPT4gUltLXTtcbn07XG5cbmZ1bmN0aW9uIGNhcGl0YWxpemVGaXJzdExldHRlcihzOiBzdHJpbmcpIHtcbiAgcmV0dXJuIHMuY2hhckF0KDApLnRvVXBwZXJDYXNlKCkgKyBzLnNsaWNlKDEpO1xufVxuIl0sIm1hcHBpbmdzIjoiQUFNQTtBQUNBO0FBQ0E7QUFDQTtBQUNBO0FBQ0EsZUFBZSxTQUFTQSxlQUFlQSxDQUNyQ0MsUUFBVyxFQUNYQyxjQUFpQyxFQUNoQjtFQUNqQixNQUFNQyxhQUE4RCxHQUFHLENBQUMsQ0FBQztFQUN6RUMsTUFBTSxDQUFDQyxJQUFJLENBQUNKLFFBQVEsQ0FBQyxDQUFDSyxPQUFPLENBQUNDLEdBQUcsSUFBSTtJQUNuQyxNQUFNQyxRQUFRLEdBQUlQLFFBQVEsQ0FBU00sR0FBRyxDQUFDO0lBQ3ZDLElBQUlDLFFBQVEsQ0FBQ0MsTUFBTSxLQUFLQyxTQUFTLEVBQy9CUCxhQUFhLENBQUMsTUFBTVEscUJBQXFCLENBQUNKLEdBQUcsQ0FBQyxFQUFFLENBQUMsR0FBRyxNQUFNO01BQ3hEO01BQ0E7TUFDQSxNQUFNSyxXQUFXLEdBQUdWLGNBQWMsQ0FBQyxDQUFDO01BQ3BDLE9BQU9NLFFBQVEsQ0FBQ0MsTUFBTSxDQUFDO1FBQUVHO01BQVksQ0FBQyxDQUFDO0lBQ3pDLENBQUM7RUFDTCxDQUFDLENBQUM7RUFDRixPQUFPVCxhQUFhO0FBQ3RCO0FBTUEsU0FBU1EscUJBQXFCQSxDQUFDRSxDQUFTLEVBQUU7RUFDeEMsT0FBT0EsQ0FBQyxDQUFDQyxNQUFNLENBQUMsQ0FBQyxDQUFDLENBQUNDLFdBQVcsQ0FBQyxDQUFDLEdBQUdGLENBQUMsQ0FBQ0csS0FBSyxDQUFDLENBQUMsQ0FBQztBQUMvQyIsImlnbm9yZUxpc3QiOltdfQ==
|
package/lib/next/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
|
|
1
|
+
|
|
2
2
|
//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJuYW1lcyI6W10sInNvdXJjZXMiOlsiLi4vLi4vc3JjL25leHQvaW5kZXgudHMiXSwic291cmNlc0NvbnRlbnQiOlsiIl0sIm1hcHBpbmdzIjoiIiwiaWdub3JlTGlzdCI6W119
|
|
@@ -21,4 +21,4 @@ export function createPaginationSchema(removeCursor, collection) {
|
|
|
21
21
|
}
|
|
22
22
|
});
|
|
23
23
|
}
|
|
24
|
-
//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJuYW1lcyI6WyJwYWdpbmF0ZWRNZXJnZSIsImV4aXN0aW5nIiwiaW5jb21pbmciLCJleGlzdGluZ1NldCIsIlNldCIsIm1lcmdlZExpc3QiLCJwayIsImhhcyIsInB1c2giLCJjcmVhdGVQYWdpbmF0aW9uU2NoZW1hIiwicmVtb3ZlQ3Vyc29yIiwiY29sbGVjdGlvbiIsIk9iamVjdCIsImNyZWF0ZSIsIm5hbWUiLCJ2YWx1ZSIsInNjaGVtYSIsIm1lcmdlIiwicGFyZW50Iiwia2V5IiwiYXJncyIsImNhbGwiXSwic291cmNlcyI6WyIuLi9zcmMvcGFnaW5hdGVkQ29sbGVjdGlvbnMudHMiXSwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHR5cGUgeyBzY2hlbWEgfSBmcm9tICdAZGF0YS1jbGllbnQvZW5kcG9pbnQnO1xuXG5leHBvcnQgZnVuY3Rpb24gcGFnaW5hdGVkTWVyZ2UoZXhpc3Rpbmc6IGFueVtdLCBpbmNvbWluZzogYW55W10pIHtcbiAgY29uc3QgZXhpc3RpbmdTZXQ6IFNldDxzdHJpbmc+ID0gbmV3IFNldChleGlzdGluZyk7XG4gIGNvbnN0IG1lcmdlZExpc3QgPSBbLi4uZXhpc3RpbmddO1xuICBmb3IgKGNvbnN0IHBrIG9mIGluY29taW5nKSB7XG4gICAgaWYgKCFleGlzdGluZ1NldC5oYXMocGspKSBtZXJnZWRMaXN0LnB1c2gocGspO1xuICB9XG4gIHJldHVybiBtZXJnZWRMaXN0O1xufVxuXG5leHBvcnQgZnVuY3Rpb24gY3JlYXRlUGFnaW5hdGlvblNjaGVtYShcbiAgcmVtb3ZlQ3Vyc29yOiAoLi4uYXJnczogcmVhZG9ubHkgYW55W10pID0+
|
|
24
|
+
//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJuYW1lcyI6WyJwYWdpbmF0ZWRNZXJnZSIsImV4aXN0aW5nIiwiaW5jb21pbmciLCJleGlzdGluZ1NldCIsIlNldCIsIm1lcmdlZExpc3QiLCJwayIsImhhcyIsInB1c2giLCJjcmVhdGVQYWdpbmF0aW9uU2NoZW1hIiwicmVtb3ZlQ3Vyc29yIiwiY29sbGVjdGlvbiIsIk9iamVjdCIsImNyZWF0ZSIsIm5hbWUiLCJ2YWx1ZSIsInNjaGVtYSIsIm1lcmdlIiwicGFyZW50Iiwia2V5IiwiYXJncyIsImNhbGwiXSwic291cmNlcyI6WyIuLi9zcmMvcGFnaW5hdGVkQ29sbGVjdGlvbnMudHMiXSwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHR5cGUgeyBzY2hlbWEgfSBmcm9tICdAZGF0YS1jbGllbnQvZW5kcG9pbnQnO1xuXG5leHBvcnQgZnVuY3Rpb24gcGFnaW5hdGVkTWVyZ2UoZXhpc3Rpbmc6IGFueVtdLCBpbmNvbWluZzogYW55W10pIHtcbiAgY29uc3QgZXhpc3RpbmdTZXQ6IFNldDxzdHJpbmc+ID0gbmV3IFNldChleGlzdGluZyk7XG4gIGNvbnN0IG1lcmdlZExpc3QgPSBbLi4uZXhpc3RpbmddO1xuICBmb3IgKGNvbnN0IHBrIG9mIGluY29taW5nKSB7XG4gICAgaWYgKCFleGlzdGluZ1NldC5oYXMocGspKSBtZXJnZWRMaXN0LnB1c2gocGspO1xuICB9XG4gIHJldHVybiBtZXJnZWRMaXN0O1xufVxuXG5leHBvcnQgZnVuY3Rpb24gY3JlYXRlUGFnaW5hdGlvblNjaGVtYShcbiAgcmVtb3ZlQ3Vyc29yOiAoLi4uYXJnczogcmVhZG9ubHkgYW55W10pID0+IGFueVtdLFxuICBjb2xsZWN0aW9uOiBzY2hlbWEuQ29sbGVjdGlvbixcbikge1xuICByZXR1cm4gT2JqZWN0LmNyZWF0ZShjb2xsZWN0aW9uLCB7XG4gICAgbmFtZToge1xuICAgICAgdmFsdWU6IGBQYWdpbmF0aW9uKCR7Y29sbGVjdGlvbi5zY2hlbWF9KWAsXG4gICAgfSxcbiAgICBtZXJnZToge1xuICAgICAgdmFsdWU6IHBhZ2luYXRlZE1lcmdlLFxuICAgIH0sXG4gICAgcGs6IHtcbiAgICAgIHZhbHVlOiBmdW5jdGlvbiAodmFsdWU6IGFueSwgcGFyZW50OiBhbnksIGtleTogYW55LCBhcmdzOiBhbnlbXSkge1xuICAgICAgICByZXR1cm4gY29sbGVjdGlvbi5way5jYWxsKFxuICAgICAgICAgIHRoaXMsXG4gICAgICAgICAgdmFsdWUsXG4gICAgICAgICAgcGFyZW50LFxuICAgICAgICAgIGtleSxcbiAgICAgICAgICByZW1vdmVDdXJzb3IoLi4uYXJncyksXG4gICAgICAgICk7XG4gICAgICB9LFxuICAgIH0sXG4gIH0pO1xufVxuIl0sIm1hcHBpbmdzIjoiQUFFQSxPQUFPLFNBQVNBLGNBQWNBLENBQUNDLFFBQWUsRUFBRUMsUUFBZSxFQUFFO0VBQy9ELE1BQU1DLFdBQXdCLEdBQUcsSUFBSUMsR0FBRyxDQUFDSCxRQUFRLENBQUM7RUFDbEQsTUFBTUksVUFBVSxHQUFHLENBQUMsR0FBR0osUUFBUSxDQUFDO0VBQ2hDLEtBQUssTUFBTUssRUFBRSxJQUFJSixRQUFRLEVBQUU7SUFDekIsSUFBSSxDQUFDQyxXQUFXLENBQUNJLEdBQUcsQ0FBQ0QsRUFBRSxDQUFDLEVBQUVELFVBQVUsQ0FBQ0csSUFBSSxDQUFDRixFQUFFLENBQUM7RUFDL0M7RUFDQSxPQUFPRCxVQUFVO0FBQ25CO0FBRUEsT0FBTyxTQUFTSSxzQkFBc0JBLENBQ3BDQyxZQUFnRCxFQUNoREMsVUFBNkIsRUFDN0I7RUFDQSxPQUFPQyxNQUFNLENBQUNDLE1BQU0sQ0FBQ0YsVUFBVSxFQUFFO0lBQy9CRyxJQUFJLEVBQUU7TUFDSkMsS0FBSyxFQUFFLGNBQWNKLFVBQVUsQ0FBQ0ssTUFBTTtJQUN4QyxDQUFDO0lBQ0RDLEtBQUssRUFBRTtNQUNMRixLQUFLLEVBQUVmO0lBQ1QsQ0FBQztJQUNETSxFQUFFLEVBQUU7TUFDRlMsS0FBSyxFQUFFLFNBQUFBLENBQVVBLEtBQVUsRUFBRUcsTUFBVyxFQUFFQyxHQUFRLEVBQUVDLElBQVcsRUFBRTtRQUMvRCxPQUFPVCxVQUFVLENBQUNMLEVBQUUsQ0FBQ2UsSUFBSSxDQUN2QixJQUFJLEVBQ0pOLEtBQUssRUFDTEcsTUFBTSxFQUNOQyxHQUFHLEVBQ0hULFlBQVksQ0FBQyxHQUFHVSxJQUFJLENBQ3RCLENBQUM7TUFDSDtJQUNGO0VBQ0YsQ0FBQyxDQUFDO0FBQ0oiLCJpZ25vcmVMaXN0IjpbXX0=
|
package/lib/resourceTypes.d.ts
CHANGED
|
@@ -4,7 +4,10 @@ import type { Denormalize } from '@data-client/endpoint';
|
|
|
4
4
|
import type { KeysToArgs, PathArgs, ResourcePath, ShortenPath } from './pathTypes.js';
|
|
5
5
|
import { Extendable } from './resourceExtendable.js';
|
|
6
6
|
import RestEndpoint, { GetEndpoint, MutateEndpoint, ParamToArgs, RestInstanceBase, RestTypeNoBody } from './RestEndpoint.js';
|
|
7
|
-
/** The typed (generic) options for a Resource
|
|
7
|
+
/** The typed (generic) options for a Resource
|
|
8
|
+
*
|
|
9
|
+
* @see https://dataclient.io/rest/api/createResource#function-inheritance-patterns
|
|
10
|
+
*/
|
|
8
11
|
export interface ResourceGenerics {
|
|
9
12
|
/** @see https://dataclient.io/rest/api/createResource#path */
|
|
10
13
|
readonly path: ResourcePath;
|
|
@@ -52,7 +55,7 @@ export interface Resource<O extends ResourceGenerics = {
|
|
|
52
55
|
path: ResourcePath;
|
|
53
56
|
schema: any;
|
|
54
57
|
}> extends Extendable<O> {
|
|
55
|
-
/** Get
|
|
58
|
+
/** Get one item (GET)
|
|
56
59
|
*
|
|
57
60
|
* @see https://dataclient.io/rest/api/createResource#get
|
|
58
61
|
*/
|
|
@@ -60,7 +63,7 @@ export interface Resource<O extends ResourceGenerics = {
|
|
|
60
63
|
path: O['path'];
|
|
61
64
|
schema: O['schema'];
|
|
62
65
|
}>;
|
|
63
|
-
/** Get
|
|
66
|
+
/** Get an Array of items (GET)
|
|
64
67
|
*
|
|
65
68
|
* @see https://dataclient.io/rest/api/createResource#getlist
|
|
66
69
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"resourceTypes.d.ts","sourceRoot":"","sources":["../src/resourceTypes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,KAAK,EACV,UAAU,EACV,QAAQ,EACR,YAAY,EACZ,WAAW,EACZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,YAAY,EAAE,EACnB,WAAW,EACX,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,cAAc,EACf,MAAM,mBAAmB,CAAC;AAE3B
|
|
1
|
+
{"version":3,"file":"resourceTypes.d.ts","sourceRoot":"","sources":["../src/resourceTypes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,KAAK,EACV,UAAU,EACV,QAAQ,EACR,YAAY,EACZ,WAAW,EACZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,YAAY,EAAE,EACnB,WAAW,EACX,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,cAAc,EACf,MAAM,mBAAmB,CAAC;AAE3B;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,8DAA8D;IAC9D,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,gEAAgE;IAChE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,0BAA0B;IAC1B,8DAA8D;IAC9D,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC;IACpB,0BAA0B;IAC1B,sEAAsE;IACtE,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC;IAC5B,yEAAyE;IACzE,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;CACnC;AACD,+CAA+C;AAC/C,MAAM,WAAW,eAAe;IAC9B,kEAAkE;IAClE,QAAQ,CAAC,EAAE,OAAO,YAAY,CAAC;IAC/B,oEAAoE;IACpE,UAAU,CAAC,EAAE,OAAO,UAAU,CAAC;IAC/B,oEAAoE;IACpE,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,mEAAmE;IACnE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,UAAU,CAAC,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC;IACtE,cAAc,CAAC,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC;IAC/D,aAAa,CAAC,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACpE,aAAa,CAAC,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACjD,0FAA0F;IAC1F,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,2FAA2F;IAC3F,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC,uDAAuD;IACvD,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,0DAA0D;IAC1D,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAClC,iDAAiD;IACjD,WAAW,CAAC,CAAC,KAAK,EAAE,GAAG,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACvD;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ,CACvB,CAAC,SAAS,gBAAgB,GAAG;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,MAAM,EAAE,GAAG,CAAA;CAAE,CAChE,SAAQ,UAAU,CAAC,CAAC,CAAC;IACrB;;;OAGG;IACH,GAAG,EAAE,WAAW,CAAC;QAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;QAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAA;KAAE,CAAC,CAAC;IAC3D;;;OAGG;IACH,OAAO,EAAE,cAAc,SAAS,MAAM,CAAC,GACrC,WAAW,CACT;QACE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7B,MAAM,EAAE,MAAM,CAAC,UAAU,CACvB;YAAC,CAAC,CAAC,QAAQ,CAAC;SAAC,EACb,WAAW,CACT,CAAC,CAAC,cAAc,CAAC,SAAS,SAAS,GACjC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAClC,CAAC,CAAC,cAAc,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CACvD,CACF,CAAC;QACF,IAAI,EAAE,MAAM,SAAS,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GACtC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QACpC,YAAY,EAAE,CAAC,CAAC,cAAc,CAAC,CAAC;KACjC,GAAG,IAAI,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAC/B,GACD,WAAW,CACT;QACE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7B,MAAM,EAAE,MAAM,CAAC,UAAU,CACvB;YAAC,CAAC,CAAC,QAAQ,CAAC;SAAC,EACb,WAAW,CACT,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,SAAS,CAAC,GACrD,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CACnC,CACF,CAAC;QACF,IAAI,EAAE,MAAM,SAAS,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GACtC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QACpC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,SAAS,CAAC;KACrE,GAAG,IAAI,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAC/B,CAAC;IACJ;;;OAGG;IACH,MAAM,EAAE,cAAc,SAAS,MAAM,CAAC,GACpC,cAAc,CAAC;QACb,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7B,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACjD,IAAI,EAAE,MAAM,SAAS,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GACtC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QACpC,YAAY,EAAE,CAAC,CAAC,cAAc,CAAC,CAAC;KACjC,CAAC,GACF,cAAc,CAAC;QACb,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7B,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACjD,IAAI,EAAE,MAAM,SAAS,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GACtC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;KACrC,CAAC,CAAC;IACL;;;OAGG;IACH,MAAM,EAAE,MAAM,SAAS,MAAM,CAAC,GAC5B,cAAc,CAAC;QACb,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;QAChB,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC;KACrB,CAAC,GACF,cAAc,CAAC;QACb,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;QAChB,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC;QACnD,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC;KACrB,CAAC,CAAC;IACL;;;OAGG;IACH,aAAa,EAAE,MAAM,SAAS,MAAM,CAAC,GACnC,cAAc,CAAC;QACb,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;QAChB,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QACzB,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC;KACrB,CAAC,GACF,cAAc,CAAC;QACb,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;QAChB,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC;QACnD,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC;KACrB,CAAC,CAAC;IACL;;;OAGG;IACH,MAAM,EAAE,cAAc,CACpB,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EACnB,CAAC,CAAC,QAAQ,CAAC,SAAS,MAAM,CAAC,eAAe,GAAG;QAAE,OAAO,EAAE,GAAG,CAAA;KAAE,GAC3D,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAC9B,CAAC,CAAC,QAAQ,CAAC,EACb,SAAS,EACT,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAC5B;QACE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;KACjB,CACF,CAAC;CACH;AAED,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,gBAAgB,CAAC;IACtB,OAAO,EAAE,gBAAgB,CAAC;IAC1B,MAAM,EAAE,gBAAgB,CAAC;IACzB,aAAa,EAAE,gBAAgB,CAAC;IAChC,MAAM,EAAE,gBAAgB,CAAC;CAC1B"}
|
package/lib/resourceTypes.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
export {};
|
|
2
|
-
//# sourceMappingURL=data:application/json;charset=utf-8;base64,
|
|
2
|
+
//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"names":[],"sources":["../src/resourceTypes.ts"],"sourcesContent":["import type { Collection, schema } from '@data-client/endpoint';\nimport type { Schema } from '@data-client/endpoint';\nimport type { Denormalize } from '@data-client/endpoint';\n\nimport type {\n  KeysToArgs,\n  PathArgs,\n  ResourcePath,\n  ShortenPath,\n} from './pathTypes.js';\nimport { Extendable } from './resourceExtendable.js';\nimport RestEndpoint, {\n  GetEndpoint,\n  MutateEndpoint,\n  ParamToArgs,\n  RestInstanceBase,\n  RestTypeNoBody,\n} from './RestEndpoint.js';\n\n/** The typed (generic) options for a Resource\n *\n * @see https://dataclient.io/rest/api/createResource#function-inheritance-patterns\n */\nexport interface ResourceGenerics {\n  /** @see https://dataclient.io/rest/api/createResource#path */\n  readonly path: ResourcePath;\n  /** @see https://dataclient.io/rest/api/createResource#schema */\n  readonly schema: Schema;\n  /** Only used for types */\n  /** @see https://dataclient.io/rest/api/createResource#body */\n  readonly body?: any;\n  /** Only used for types */\n  /** @see https://dataclient.io/rest/api/createResource#searchParams */\n  readonly searchParams?: any;\n  /** @see https://dataclient.io/rest/api/createResource#paginationfield */\n  readonly paginationField?: string;\n}\n/** The untyped options for createResource() */\nexport interface ResourceOptions {\n  /** @see https://dataclient.io/rest/api/createResource#endpoint */\n  Endpoint?: typeof RestEndpoint;\n  /** @see https://dataclient.io/rest/api/createResource#collection */\n  Collection?: typeof Collection;\n  /** @see https://dataclient.io/rest/api/createResource#optimistic */\n  optimistic?: boolean;\n  /** @see https://dataclient.io/rest/api/createResource#urlprefix */\n  urlPrefix?: string;\n  requestInit?: RequestInit;\n  getHeaders?(headers: HeadersInit): Promise<HeadersInit> | HeadersInit;\n  getRequestInit?(body: any): Promise<RequestInit> | RequestInit;\n  fetchResponse?(input: RequestInfo, init: RequestInit): Promise<any>;\n  parseResponse?(response: Response): Promise<any>;\n  /** Default data expiry length, will fall back to NetworkManager default if not defined */\n  readonly dataExpiryLength?: number;\n  /** Default error expiry length, will fall back to NetworkManager default if not defined */\n  readonly errorExpiryLength?: number;\n  /** Poll with at least this frequency in miliseconds */\n  readonly pollFrequency?: number;\n  /** Marks cached resources as invalid if they are stale */\n  readonly invalidIfStale?: boolean;\n  /** Determines whether to throw or fallback to */\n  errorPolicy?(error: any): 'hard' | 'soft' | undefined;\n}\n\n/** Resources are a collection of methods for a given data model.\n * @see https://dataclient.io/rest/api/createResource\n */\nexport interface Resource<\n  O extends ResourceGenerics = { path: ResourcePath; schema: any },\n> extends Extendable<O> {\n  /** Get one item (GET)\n   *\n   * @see https://dataclient.io/rest/api/createResource#get\n   */\n  get: GetEndpoint<{ path: O['path']; schema: O['schema'] }>;\n  /** Get an Array of items (GET)\n   *\n   * @see https://dataclient.io/rest/api/createResource#getlist\n   */\n  getList: 'searchParams' extends keyof O ?\n    GetEndpoint<\n      {\n        path: ShortenPath<O['path']>;\n        schema: schema.Collection<\n          [O['schema']],\n          ParamToArgs<\n            O['searchParams'] extends undefined ?\n              KeysToArgs<ShortenPath<O['path']>>\n            : O['searchParams'] & PathArgs<ShortenPath<O['path']>>\n          >\n        >;\n        body: 'body' extends keyof O ? O['body']\n        : Partial<Denormalize<O['schema']>>;\n        searchParams: O['searchParams'];\n      } & Pick<O, 'paginationField'>\n    >\n  : GetEndpoint<\n      {\n        path: ShortenPath<O['path']>;\n        schema: schema.Collection<\n          [O['schema']],\n          ParamToArgs<\n            (Record<string, number | string | boolean> | undefined) &\n              PathArgs<ShortenPath<O['path']>>\n          >\n        >;\n        body: 'body' extends keyof O ? O['body']\n        : Partial<Denormalize<O['schema']>>;\n        searchParams: Record<string, number | string | boolean> | undefined;\n      } & Pick<O, 'paginationField'>\n    >;\n  /** Create a new item (POST)\n   *\n   * @deprecated use Resource.getList.push instead\n   */\n  create: 'searchParams' extends keyof O ?\n    MutateEndpoint<{\n      path: ShortenPath<O['path']>;\n      schema: schema.Collection<[O['schema']]>['push'];\n      body: 'body' extends keyof O ? O['body']\n      : Partial<Denormalize<O['schema']>>;\n      searchParams: O['searchParams'];\n    }>\n  : MutateEndpoint<{\n      path: ShortenPath<O['path']>;\n      schema: schema.Collection<[O['schema']]>['push'];\n      body: 'body' extends keyof O ? O['body']\n      : Partial<Denormalize<O['schema']>>;\n    }>;\n  /** Update an item (PUT)\n   *\n   * @see https://dataclient.io/rest/api/createResource#update\n   */\n  update: 'body' extends keyof O ?\n    MutateEndpoint<{\n      path: O['path'];\n      body: O['body'];\n      schema: O['schema'];\n    }>\n  : MutateEndpoint<{\n      path: O['path'];\n      body: Partial<Denormalize<O['schema']>> | FormData;\n      schema: O['schema'];\n    }>;\n  /** Update an item (PATCH)\n   *\n   * @see https://dataclient.io/rest/api/createResource#partialupdate\n   */\n  partialUpdate: 'body' extends keyof O ?\n    MutateEndpoint<{\n      path: O['path'];\n      body: Partial<O['body']>;\n      schema: O['schema'];\n    }>\n  : MutateEndpoint<{\n      path: O['path'];\n      body: Partial<Denormalize<O['schema']>> | FormData;\n      schema: O['schema'];\n    }>;\n  /** Delete an item (DELETE)\n   *\n   * @see https://dataclient.io/rest/api/createResource#delete\n   */\n  delete: RestTypeNoBody<\n    PathArgs<O['path']>,\n    O['schema'] extends schema.EntityInterface & { process: any } ?\n      schema.Invalidate<O['schema']>\n    : O['schema'],\n    undefined,\n    Partial<PathArgs<O['path']>>,\n    {\n      path: O['path'];\n    }\n  >;\n}\n\nexport interface ResourceInterface {\n  get: RestInstanceBase;\n  getList: RestInstanceBase;\n  update: RestInstanceBase;\n  partialUpdate: RestInstanceBase;\n  delete: RestInstanceBase;\n}\n"],"mappings":"","ignoreList":[]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@data-client/rest",
|
|
3
|
-
"version": "0.12.
|
|
3
|
+
"version": "0.12.8",
|
|
4
4
|
"description": "Endpoints for REST APIs",
|
|
5
5
|
"homepage": "https://dataclient.io/rest",
|
|
6
6
|
"repository": {
|
|
@@ -129,7 +129,7 @@
|
|
|
129
129
|
"license": "Apache-2.0",
|
|
130
130
|
"dependencies": {
|
|
131
131
|
"@babel/runtime": "^7.17.0",
|
|
132
|
-
"@data-client/endpoint": "^0.12.
|
|
132
|
+
"@data-client/endpoint": "^0.12.7",
|
|
133
133
|
"path-to-regexp": "^6.2.1"
|
|
134
134
|
},
|
|
135
135
|
"devDependencies": {
|
package/src/RestEndpointTypes.ts
CHANGED
|
@@ -139,7 +139,7 @@ export interface RestInstance<
|
|
|
139
139
|
this: E,
|
|
140
140
|
cursorField: C,
|
|
141
141
|
): PaginationFieldEndpoint<E, C>;
|
|
142
|
-
/**
|
|
142
|
+
/** Concatinate the next page of results (GET)
|
|
143
143
|
* @see https://dataclient.io/rest/api/RestEndpoint#getPage
|
|
144
144
|
*/
|
|
145
145
|
getPage: 'paginationField' extends keyof O ?
|
|
@@ -150,7 +150,7 @@ export interface RestInstance<
|
|
|
150
150
|
>
|
|
151
151
|
: undefined
|
|
152
152
|
: undefined;
|
|
153
|
-
/**
|
|
153
|
+
/** Create a new item (POST) and `push` to the end
|
|
154
154
|
* @see https://dataclient.io/rest/api/RestEndpoint#push
|
|
155
155
|
*/
|
|
156
156
|
push: AddEndpoint<
|
|
@@ -163,7 +163,7 @@ export interface RestInstance<
|
|
|
163
163
|
| FormData;
|
|
164
164
|
}
|
|
165
165
|
>;
|
|
166
|
-
/**
|
|
166
|
+
/** Create a new item (POST) and `unshift` to the beginning
|
|
167
167
|
* @see https://dataclient.io/rest/api/RestEndpoint#unshift
|
|
168
168
|
*/
|
|
169
169
|
unshift: AddEndpoint<
|
|
@@ -176,7 +176,7 @@ export interface RestInstance<
|
|
|
176
176
|
| FormData;
|
|
177
177
|
}
|
|
178
178
|
>;
|
|
179
|
-
/**
|
|
179
|
+
/** Create new item(s) (POST) and `Object.assign` merge
|
|
180
180
|
* @see https://dataclient.io/rest/api/RestEndpoint#assign
|
|
181
181
|
*/
|
|
182
182
|
assign: AddEndpoint<
|
|
@@ -345,6 +345,10 @@ export interface PartialRestGenerics {
|
|
|
345
345
|
/** @see https://dataclient.io/rest/api/RestEndpoint#process */
|
|
346
346
|
process?(value: any, ...args: any): any;
|
|
347
347
|
}
|
|
348
|
+
/** Generic types when constructing a RestEndpoint
|
|
349
|
+
*
|
|
350
|
+
* @see https://dataclient.io/rest/api/RestEndpoint#inheritance
|
|
351
|
+
*/
|
|
348
352
|
export interface RestGenerics extends PartialRestGenerics {
|
|
349
353
|
readonly path: string;
|
|
350
354
|
}
|
|
@@ -410,11 +414,26 @@ export interface RestEndpointOptions<
|
|
|
410
414
|
F extends FetchFunction = FetchFunction,
|
|
411
415
|
S extends Schema | undefined = undefined,
|
|
412
416
|
> extends EndpointExtraOptions<F> {
|
|
417
|
+
/** Prepended to all urls
|
|
418
|
+
* @see https://dataclient.io/rest/api/RestEndpoint#urlPrefix
|
|
419
|
+
*/
|
|
413
420
|
urlPrefix?: string;
|
|
414
421
|
requestInit?: RequestInit;
|
|
422
|
+
/** Called by getRequestInit to determine HTTP Headers
|
|
423
|
+
* @see https://dataclient.io/rest/api/RestEndpoint#getHeaders
|
|
424
|
+
*/
|
|
415
425
|
getHeaders?(headers: HeadersInit): Promise<HeadersInit> | HeadersInit;
|
|
426
|
+
/** Prepares RequestInit used in fetch. This is sent to fetchResponse()
|
|
427
|
+
* @see https://dataclient.io/rest/api/RestEndpoint#getRequestInit
|
|
428
|
+
*/
|
|
416
429
|
getRequestInit?(body: any): Promise<RequestInit> | RequestInit;
|
|
430
|
+
/** Performs the fetch call
|
|
431
|
+
* @see https://dataclient.io/rest/api/RestEndpoint#fetchResponse
|
|
432
|
+
*/
|
|
417
433
|
fetchResponse?(input: RequestInfo, init: RequestInit): Promise<any>;
|
|
434
|
+
/** Takes the Response and parses via .text() or .json()
|
|
435
|
+
* @see https://dataclient.io/rest/api/RestEndpoint#parseResponse
|
|
436
|
+
*/
|
|
418
437
|
parseResponse?(response: Response): Promise<any>;
|
|
419
438
|
|
|
420
439
|
sideEffect?: boolean | undefined;
|
|
@@ -477,6 +496,10 @@ export interface RestEndpoint<O extends RestGenerics = any>
|
|
|
477
496
|
> {}
|
|
478
497
|
|
|
479
498
|
export interface RestEndpointConstructor {
|
|
499
|
+
/** Simplifies endpoint definitions that follow REST patterns
|
|
500
|
+
*
|
|
501
|
+
* @see https://dataclient.io/rest/api/RestEndpoint
|
|
502
|
+
*/
|
|
480
503
|
new <O extends RestGenerics = any>({
|
|
481
504
|
method,
|
|
482
505
|
sideEffect,
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { Entity, PolymorphicInterface, schema } from '@data-client/endpoint';
|
|
2
|
+
import type { DefaultArgs } from '@data-client/endpoint';
|
|
2
3
|
import {
|
|
3
4
|
CacheProvider,
|
|
4
5
|
useCache,
|
|
@@ -1169,10 +1170,7 @@ describe('createResource()', () => {
|
|
|
1169
1170
|
it('should warn when mis-capitalizing options', () => {
|
|
1170
1171
|
class MyCollection<
|
|
1171
1172
|
S extends any[] | PolymorphicInterface = any,
|
|
1172
|
-
Args extends any[] =
|
|
1173
|
-
| []
|
|
1174
|
-
| [urlParams: Record<string, any>]
|
|
1175
|
-
| [urlParams: Record<string, any>, body: any],
|
|
1173
|
+
Args extends any[] = DefaultArgs,
|
|
1176
1174
|
Parent = any,
|
|
1177
1175
|
> extends schema.Collection<S, Args, Parent> {
|
|
1178
1176
|
// getList.push should add to Collections regardless of its 'orderBy' argument
|
package/src/resourceTypes.ts
CHANGED
|
@@ -17,7 +17,10 @@ import RestEndpoint, {
|
|
|
17
17
|
RestTypeNoBody,
|
|
18
18
|
} from './RestEndpoint.js';
|
|
19
19
|
|
|
20
|
-
/** The typed (generic) options for a Resource
|
|
20
|
+
/** The typed (generic) options for a Resource
|
|
21
|
+
*
|
|
22
|
+
* @see https://dataclient.io/rest/api/createResource#function-inheritance-patterns
|
|
23
|
+
*/
|
|
21
24
|
export interface ResourceGenerics {
|
|
22
25
|
/** @see https://dataclient.io/rest/api/createResource#path */
|
|
23
26
|
readonly path: ResourcePath;
|
|
@@ -65,12 +68,12 @@ export interface ResourceOptions {
|
|
|
65
68
|
export interface Resource<
|
|
66
69
|
O extends ResourceGenerics = { path: ResourcePath; schema: any },
|
|
67
70
|
> extends Extendable<O> {
|
|
68
|
-
/** Get
|
|
71
|
+
/** Get one item (GET)
|
|
69
72
|
*
|
|
70
73
|
* @see https://dataclient.io/rest/api/createResource#get
|
|
71
74
|
*/
|
|
72
75
|
get: GetEndpoint<{ path: O['path']; schema: O['schema'] }>;
|
|
73
|
-
/** Get
|
|
76
|
+
/** Get an Array of items (GET)
|
|
74
77
|
*
|
|
75
78
|
* @see https://dataclient.io/rest/api/createResource#getlist
|
|
76
79
|
*/
|
|
@@ -86,26 +86,26 @@ export interface RestInstance<F extends FetchFunction = FetchFunction, S extends
|
|
|
86
86
|
...Parameters<E>
|
|
87
87
|
]): PaginationEndpoint<E, A>;
|
|
88
88
|
paginated<E extends RestInstanceBase<FetchFunction, any, undefined>, C extends string>(this: E, cursorField: C): PaginationFieldEndpoint<E, C>;
|
|
89
|
-
/**
|
|
89
|
+
/** Concatinate the next page of results (GET)
|
|
90
90
|
* @see https://dataclient.io/rest/api/RestEndpoint#getPage
|
|
91
91
|
*/
|
|
92
92
|
getPage: 'paginationField' extends keyof O ? O['paginationField'] extends string ? PaginationFieldEndpoint<F & {
|
|
93
93
|
schema: S;
|
|
94
94
|
sideEffect: M;
|
|
95
95
|
} & O, O['paginationField']> : undefined : undefined;
|
|
96
|
-
/**
|
|
96
|
+
/** Create a new item (POST) and `push` to the end
|
|
97
97
|
* @see https://dataclient.io/rest/api/RestEndpoint#push
|
|
98
98
|
*/
|
|
99
99
|
push: AddEndpoint<F, ExtractCollection<S>['push'], Exclude<O, 'body' | 'method'> & {
|
|
100
100
|
body: OptionsToAdderBodyArgument<O> | OptionsToAdderBodyArgument<O>[] | FormData;
|
|
101
101
|
}>;
|
|
102
|
-
/**
|
|
102
|
+
/** Create a new item (POST) and `unshift` to the beginning
|
|
103
103
|
* @see https://dataclient.io/rest/api/RestEndpoint#unshift
|
|
104
104
|
*/
|
|
105
105
|
unshift: AddEndpoint<F, ExtractCollection<S>['unshift'], Exclude<O, 'body' | 'method'> & {
|
|
106
106
|
body: OptionsToAdderBodyArgument<O> | OptionsToAdderBodyArgument<O>[] | FormData;
|
|
107
107
|
}>;
|
|
108
|
-
/**
|
|
108
|
+
/** Create new item(s) (POST) and `Object.assign` merge
|
|
109
109
|
* @see https://dataclient.io/rest/api/RestEndpoint#assign
|
|
110
110
|
*/
|
|
111
111
|
assign: AddEndpoint<F, ExtractCollection<S>, Exclude<O, 'body' | 'method'> & {
|
|
@@ -173,6 +173,10 @@ export interface PartialRestGenerics {
|
|
|
173
173
|
/** @see https://dataclient.io/rest/api/RestEndpoint#process */
|
|
174
174
|
process?(value: any, ...args: any): any;
|
|
175
175
|
}
|
|
176
|
+
/** Generic types when constructing a RestEndpoint
|
|
177
|
+
*
|
|
178
|
+
* @see https://dataclient.io/rest/api/RestEndpoint#inheritance
|
|
179
|
+
*/
|
|
176
180
|
export interface RestGenerics extends PartialRestGenerics {
|
|
177
181
|
readonly path: string;
|
|
178
182
|
}
|
|
@@ -206,11 +210,26 @@ type OptionsToAdderBodyArgument<O extends {
|
|
|
206
210
|
body?: any;
|
|
207
211
|
}> = 'body' extends keyof O ? O['body'] : any;
|
|
208
212
|
export interface RestEndpointOptions<F extends FetchFunction = FetchFunction, S extends Schema | undefined = undefined> extends EndpointExtraOptions<F> {
|
|
213
|
+
/** Prepended to all urls
|
|
214
|
+
* @see https://dataclient.io/rest/api/RestEndpoint#urlPrefix
|
|
215
|
+
*/
|
|
209
216
|
urlPrefix?: string;
|
|
210
217
|
requestInit?: RequestInit;
|
|
218
|
+
/** Called by getRequestInit to determine HTTP Headers
|
|
219
|
+
* @see https://dataclient.io/rest/api/RestEndpoint#getHeaders
|
|
220
|
+
*/
|
|
211
221
|
getHeaders?(headers: HeadersInit): Promise<HeadersInit> | HeadersInit;
|
|
222
|
+
/** Prepares RequestInit used in fetch. This is sent to fetchResponse()
|
|
223
|
+
* @see https://dataclient.io/rest/api/RestEndpoint#getRequestInit
|
|
224
|
+
*/
|
|
212
225
|
getRequestInit?(body: any): Promise<RequestInit> | RequestInit;
|
|
226
|
+
/** Performs the fetch call
|
|
227
|
+
* @see https://dataclient.io/rest/api/RestEndpoint#fetchResponse
|
|
228
|
+
*/
|
|
213
229
|
fetchResponse?(input: RequestInfo, init: RequestInit): Promise<any>;
|
|
230
|
+
/** Takes the Response and parses via .text() or .json()
|
|
231
|
+
* @see https://dataclient.io/rest/api/RestEndpoint#parseResponse
|
|
232
|
+
*/
|
|
214
233
|
parseResponse?(response: Response): Promise<any>;
|
|
215
234
|
sideEffect?: boolean | undefined;
|
|
216
235
|
name?: string;
|
|
@@ -236,6 +255,10 @@ export interface RestEndpoint<O extends RestGenerics = any> extends RestInstance
|
|
|
236
255
|
}> {
|
|
237
256
|
}
|
|
238
257
|
export interface RestEndpointConstructor {
|
|
258
|
+
/** Simplifies endpoint definitions that follow REST patterns
|
|
259
|
+
*
|
|
260
|
+
* @see https://dataclient.io/rest/api/RestEndpoint
|
|
261
|
+
*/
|
|
239
262
|
new <O extends RestGenerics = any>({ method, sideEffect, name, ...options }: RestEndpointConstructorOptions<O> & Readonly<O>): RestEndpoint<O>;
|
|
240
263
|
readonly prototype: RestInstanceBase;
|
|
241
264
|
}
|
package/ts4.0/resourceTypes.d.ts
CHANGED
|
@@ -4,7 +4,10 @@ import type { Denormalize } from '@data-client/endpoint';
|
|
|
4
4
|
import type { KeysToArgs, PathArgs, ResourcePath, ShortenPath } from './pathTypes.js';
|
|
5
5
|
import { Extendable } from './resourceExtendable.js';
|
|
6
6
|
import RestEndpoint, { GetEndpoint, MutateEndpoint, ParamToArgs, RestInstanceBase, RestTypeNoBody } from './RestEndpoint.js';
|
|
7
|
-
/** The typed (generic) options for a Resource
|
|
7
|
+
/** The typed (generic) options for a Resource
|
|
8
|
+
*
|
|
9
|
+
* @see https://dataclient.io/rest/api/createResource#function-inheritance-patterns
|
|
10
|
+
*/
|
|
8
11
|
export interface ResourceGenerics {
|
|
9
12
|
/** @see https://dataclient.io/rest/api/createResource#path */
|
|
10
13
|
readonly path: ResourcePath;
|
|
@@ -52,7 +55,7 @@ export interface Resource<O extends ResourceGenerics = {
|
|
|
52
55
|
path: ResourcePath;
|
|
53
56
|
schema: any;
|
|
54
57
|
}> extends Extendable<O> {
|
|
55
|
-
/** Get
|
|
58
|
+
/** Get one item (GET)
|
|
56
59
|
*
|
|
57
60
|
* @see https://dataclient.io/rest/api/createResource#get
|
|
58
61
|
*/
|
|
@@ -60,7 +63,7 @@ export interface Resource<O extends ResourceGenerics = {
|
|
|
60
63
|
path: O['path'];
|
|
61
64
|
schema: O['schema'];
|
|
62
65
|
}>;
|
|
63
|
-
/** Get
|
|
66
|
+
/** Get an Array of items (GET)
|
|
64
67
|
*
|
|
65
68
|
* @see https://dataclient.io/rest/api/createResource#getlist
|
|
66
69
|
*/
|
|
@@ -86,26 +86,26 @@ export interface RestInstance<F extends FetchFunction = FetchFunction, S extends
|
|
|
86
86
|
...Parameters<E>
|
|
87
87
|
]): PaginationEndpoint<E, A>;
|
|
88
88
|
paginated<E extends RestInstanceBase<FetchFunction, any, undefined>, C extends string>(this: E, cursorField: C): PaginationFieldEndpoint<E, C>;
|
|
89
|
-
/**
|
|
89
|
+
/** Concatinate the next page of results (GET)
|
|
90
90
|
* @see https://dataclient.io/rest/api/RestEndpoint#getPage
|
|
91
91
|
*/
|
|
92
92
|
getPage: 'paginationField' extends keyof O ? O['paginationField'] extends string ? PaginationFieldEndpoint<F & {
|
|
93
93
|
schema: S;
|
|
94
94
|
sideEffect: M;
|
|
95
95
|
} & O, O['paginationField']> : undefined : undefined;
|
|
96
|
-
/**
|
|
96
|
+
/** Create a new item (POST) and `push` to the end
|
|
97
97
|
* @see https://dataclient.io/rest/api/RestEndpoint#push
|
|
98
98
|
*/
|
|
99
99
|
push: AddEndpoint<F, ExtractCollection<S>['push'], Exclude<O, 'body' | 'method'> & {
|
|
100
100
|
body: OptionsToAdderBodyArgument<O> | OptionsToAdderBodyArgument<O>[] | FormData;
|
|
101
101
|
}>;
|
|
102
|
-
/**
|
|
102
|
+
/** Create a new item (POST) and `unshift` to the beginning
|
|
103
103
|
* @see https://dataclient.io/rest/api/RestEndpoint#unshift
|
|
104
104
|
*/
|
|
105
105
|
unshift: AddEndpoint<F, ExtractCollection<S>['unshift'], Exclude<O, 'body' | 'method'> & {
|
|
106
106
|
body: OptionsToAdderBodyArgument<O> | OptionsToAdderBodyArgument<O>[] | FormData;
|
|
107
107
|
}>;
|
|
108
|
-
/**
|
|
108
|
+
/** Create new item(s) (POST) and `Object.assign` merge
|
|
109
109
|
* @see https://dataclient.io/rest/api/RestEndpoint#assign
|
|
110
110
|
*/
|
|
111
111
|
assign: AddEndpoint<F, ExtractCollection<S>, Exclude<O, 'body' | 'method'> & {
|
|
@@ -173,6 +173,10 @@ export interface PartialRestGenerics {
|
|
|
173
173
|
/** @see https://dataclient.io/rest/api/RestEndpoint#process */
|
|
174
174
|
process?(value: any, ...args: any): any;
|
|
175
175
|
}
|
|
176
|
+
/** Generic types when constructing a RestEndpoint
|
|
177
|
+
*
|
|
178
|
+
* @see https://dataclient.io/rest/api/RestEndpoint#inheritance
|
|
179
|
+
*/
|
|
176
180
|
export interface RestGenerics extends PartialRestGenerics {
|
|
177
181
|
readonly path: string;
|
|
178
182
|
}
|
|
@@ -206,11 +210,26 @@ type OptionsToAdderBodyArgument<O extends {
|
|
|
206
210
|
body?: any;
|
|
207
211
|
}> = 'body' extends keyof O ? O['body'] : any;
|
|
208
212
|
export interface RestEndpointOptions<F extends FetchFunction = FetchFunction, S extends Schema | undefined = undefined> extends EndpointExtraOptions<F> {
|
|
213
|
+
/** Prepended to all urls
|
|
214
|
+
* @see https://dataclient.io/rest/api/RestEndpoint#urlPrefix
|
|
215
|
+
*/
|
|
209
216
|
urlPrefix?: string;
|
|
210
217
|
requestInit?: RequestInit;
|
|
218
|
+
/** Called by getRequestInit to determine HTTP Headers
|
|
219
|
+
* @see https://dataclient.io/rest/api/RestEndpoint#getHeaders
|
|
220
|
+
*/
|
|
211
221
|
getHeaders?(headers: HeadersInit): Promise<HeadersInit> | HeadersInit;
|
|
222
|
+
/** Prepares RequestInit used in fetch. This is sent to fetchResponse()
|
|
223
|
+
* @see https://dataclient.io/rest/api/RestEndpoint#getRequestInit
|
|
224
|
+
*/
|
|
212
225
|
getRequestInit?(body: any): Promise<RequestInit> | RequestInit;
|
|
226
|
+
/** Performs the fetch call
|
|
227
|
+
* @see https://dataclient.io/rest/api/RestEndpoint#fetchResponse
|
|
228
|
+
*/
|
|
213
229
|
fetchResponse?(input: RequestInfo, init: RequestInit): Promise<any>;
|
|
230
|
+
/** Takes the Response and parses via .text() or .json()
|
|
231
|
+
* @see https://dataclient.io/rest/api/RestEndpoint#parseResponse
|
|
232
|
+
*/
|
|
214
233
|
parseResponse?(response: Response): Promise<any>;
|
|
215
234
|
sideEffect?: boolean | undefined;
|
|
216
235
|
name?: string;
|
|
@@ -236,6 +255,10 @@ export interface RestEndpoint<O extends RestGenerics = any> extends RestInstance
|
|
|
236
255
|
}> {
|
|
237
256
|
}
|
|
238
257
|
export interface RestEndpointConstructor {
|
|
258
|
+
/** Simplifies endpoint definitions that follow REST patterns
|
|
259
|
+
*
|
|
260
|
+
* @see https://dataclient.io/rest/api/RestEndpoint
|
|
261
|
+
*/
|
|
239
262
|
new <O extends RestGenerics = any>({ method, sideEffect, name, ...options }: RestEndpointConstructorOptions<O> & Readonly<O>): RestEndpoint<O>;
|
|
240
263
|
readonly prototype: RestInstanceBase;
|
|
241
264
|
}
|
package/ts4.1/resourceTypes.d.ts
CHANGED
|
@@ -4,7 +4,10 @@ import type { Denormalize } from '@data-client/endpoint';
|
|
|
4
4
|
import type { KeysToArgs, PathArgs, ResourcePath, ShortenPath } from './pathTypes.js';
|
|
5
5
|
import { Extendable } from './resourceExtendable.js';
|
|
6
6
|
import RestEndpoint, { GetEndpoint, MutateEndpoint, ParamToArgs, RestInstanceBase, RestTypeNoBody } from './RestEndpoint.js';
|
|
7
|
-
/** The typed (generic) options for a Resource
|
|
7
|
+
/** The typed (generic) options for a Resource
|
|
8
|
+
*
|
|
9
|
+
* @see https://dataclient.io/rest/api/createResource#function-inheritance-patterns
|
|
10
|
+
*/
|
|
8
11
|
export interface ResourceGenerics {
|
|
9
12
|
/** @see https://dataclient.io/rest/api/createResource#path */
|
|
10
13
|
readonly path: ResourcePath;
|
|
@@ -52,7 +55,7 @@ export interface Resource<O extends ResourceGenerics = {
|
|
|
52
55
|
path: ResourcePath;
|
|
53
56
|
schema: any;
|
|
54
57
|
}> extends Extendable<O> {
|
|
55
|
-
/** Get
|
|
58
|
+
/** Get one item (GET)
|
|
56
59
|
*
|
|
57
60
|
* @see https://dataclient.io/rest/api/createResource#get
|
|
58
61
|
*/
|
|
@@ -60,7 +63,7 @@ export interface Resource<O extends ResourceGenerics = {
|
|
|
60
63
|
path: O['path'];
|
|
61
64
|
schema: O['schema'];
|
|
62
65
|
}>;
|
|
63
|
-
/** Get
|
|
66
|
+
/** Get an Array of items (GET)
|
|
64
67
|
*
|
|
65
68
|
* @see https://dataclient.io/rest/api/createResource#getlist
|
|
66
69
|
*/
|