@mountainpass/waycharter 1.0.75 → 2.0.1

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+## <small>2.0.1 (2022-08-03)</small>
+
+* feat(collections): added support for non-numberic paging ([7ecead9](https://github.com/mountain-pass/waycharter/commit/7ecead9))
+
+
+
+## 2.0.0 (2022-06-23)
+
+* build(lint): fixing linting issues ([0053c11](https://github.com/mountain-pass/waycharter/commit/0053c11))
+
+
+
+## <small>1.0.76 (2021-12-16)</small>
+
+* fix(collections): fixed first, next, prev links for templated collections ([3ed681a](https://github.com/mountain-pass/waycharter/commit/3ed681a))
+
+
+
 ## <small>1.0.75 (2021-12-13)</small>
 
 * feat(collections): item endpoints can now be used when registering collections ([15fa46d](https://github.com/mountain-pass/waycharter/commit/15fa46d))

package/README.md

@@ -13,7 +13,7 @@ This library is compatible with Node.js 10.x, 12.x and 14.x
 
 <!-- [![Quality](https://img.shields.io/codacy/grade/940768d54f7545f7b42f89b26c23c751?logo=codacy)](https://www.codacy.com/gh/mountain-pass/waycharter/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=mountain-pass/waycharter&amp;utm_campaign=Badge_Grade) [![Coverage](https://img.shields.io/codacy/coverage/940768d54f7545f7b42f89b26c23c751?logo=codacy)](https://www.codacy.com/gh/mountain-pass/waycharter/dashboard?utm_source=github.com&utm_medium=referral&utm_content=mountain-pass/waycharter&utm_campaign=Badge_Coverage) -->
 
-[![source code vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/mountain-pass/waycharter?label=source%20code%20vulnerabilities&logo=snyk)](https://snyk.io/test/github/mountain-pass/waycharter) [![npm package vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/@mountainpass/waycharter@1.0.75?label=npm%20package%20vulnerabilties&logo=snyk)](https://snyk.io/test/npm/@mountainpass/waycharter/1.0.75)
+[![source code vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/mountain-pass/waycharter?label=source%20code%20vulnerabilities&logo=snyk)](https://snyk.io/test/github/mountain-pass/waycharter) [![npm package vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/@mountainpass/waycharter@2.0.1?label=npm%20package%20vulnerabilties&logo=snyk)](https://snyk.io/test/npm/@mountainpass/waycharter/2.0.1)
 
 
 [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

package/dist/action.d.ts

@@ -0,0 +1,8 @@
+import { ActionMap, ItemActionMap } from './method';
+import { BaseLink } from './link';
+import { ActionHandler } from './handler';
+export declare type Action<ActionResponseBody> = Omit<BaseLink, 'uri' | 'method'> & {
+    handler: ActionHandler<ActionResponseBody>;
+} & Record<string, any>;
+export declare type Actions<ActionResponseBody> = ActionMap<Array<Action<ActionResponseBody>>>;
+export declare type ItemActions<CanonicalItemActionResponseBody> = ItemActionMap<Array<Action<CanonicalItemActionResponseBody>>>;

package/dist/action.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=action.js.map

package/dist/action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"action.js","sourceRoot":"","sources":["../src/action.ts"],"names":[],"mappings":""}

package/dist/collections/build-first-link.d.ts

@@ -0,0 +1,13 @@
+import { Query } from 'express-serve-static-core';
+/**
+ * @param hasMore
+ * @param pageInt
+ * @param page
+ * @param firstPage
+ * @param collectionPath
+ * @param otherParameters
+ */
+export declare function buildFirstLink(collectionPath: string, otherParameters: Query): {
+    rel: string;
+    uri: string;
+}[];

package/dist/collections/build-first-link.js

@@ -1,28 +1,39 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.buildFirstLink = buildFirstLink;
-
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildFirstLink = void 0;
 /**
  * @param hasMore
  * @param pageInt
+ * @param page
+ * @param firstPage
  * @param collectionPath
  * @param otherParameters
  */
-function buildFirstLink(hasMore, pageInt, collectionPath, otherParameters) {
-  if (pageInt > 0 || hasMore) {
-    return Object.keys(otherParameters).length > 0 ? [{
-      rel: 'first',
-      uri: `${collectionPath}?${new URLSearchParams({ ...otherParameters
-      }).toString()}`
-    }] : [{
-      rel: 'first',
-      uri: collectionPath
-    }];
-  } else {
-    return [];
-  }
+function buildFirstLink(collectionPath, otherParameters) {
+    return Object.keys(otherParameters).length > 0
+        ? [
+            {
+                rel: 'first',
+                uri: "".concat(collectionPath, "?").concat(new URLSearchParams(__assign({}, otherParameters)).toString())
+            }
+        ]
+        : [
+            {
+                rel: 'first',
+                uri: collectionPath
+            }
+        ];
 }
+exports.buildFirstLink = buildFirstLink;
 //# sourceMappingURL=build-first-link.js.map

package/dist/collections/build-first-link.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/collections/build-first-link.js"],"names":["buildFirstLink","hasMore","pageInt","collectionPath","otherParameters","Object","keys","length","rel","uri","URLSearchParams","toString"],"mappings":";;;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACO,SAASA,cAAT,CACLC,OADK,EAELC,OAFK,EAGLC,cAHK,EAILC,eAJK,EAKL;AACA,MAAIF,OAAO,GAAG,CAAV,IAAeD,OAAnB,EAA4B;AAC1B,WAAOI,MAAM,CAACC,IAAP,CAAYF,eAAZ,EAA6BG,MAA7B,GAAsC,CAAtC,GACH,CACE;AACEC,MAAAA,GAAG,EAAE,OADP;AAEEC,MAAAA,GAAG,EAAG,GAAEN,cAAe,IAAG,IAAIO,eAAJ,CAAoB,EAC5C,GAAGN;AADyC,OAApB,EAEvBO,QAFuB,EAEZ;AAJhB,KADF,CADG,GASH,CACE;AACEH,MAAAA,GAAG,EAAE,OADP;AAEEC,MAAAA,GAAG,EAAEN;AAFP,KADF,CATJ;AAeD,GAhBD,MAgBO;AACL,WAAO,EAAP;AACD;AACF","sourcesContent":["/**\n * @param hasMore\n * @param pageInt\n * @param collectionPath\n * @param otherParameters\n */\nexport function buildFirstLink (\n  hasMore,\n  pageInt,\n  collectionPath,\n  otherParameters\n) {\n  if (pageInt > 0 || hasMore) {\n    return Object.keys(otherParameters).length > 0\n      ? [\n          {\n            rel: 'first',\n            uri: `${collectionPath}?${new URLSearchParams({\n              ...otherParameters\n            }).toString()}`\n          }\n        ]\n      : [\n          {\n            rel: 'first',\n            uri: collectionPath\n          }\n        ]\n  } else {\n    return []\n  }\n}\n"],"file":"build-first-link.js"}
+{"version":3,"file":"build-first-link.js","sourceRoot":"","sources":["../../src/collections/build-first-link.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAEA;;;;;;;GAOG;AACH,SAAgB,cAAc,CAC5B,cAAsB,EACtB,eAAsB;IAEtB,OAAO,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,GAAG,CAAC;QAC5C,CAAC,CAAC;YACA;gBACE,GAAG,EAAE,OAAO;gBACZ,GAAG,EAAE,UAAG,cAAc,cAAI,IAAI,eAAe,cACxC,eAAyC,EAC5C,CAAC,QAAQ,EAAE,CAAE;aAChB;SACF;QACD,CAAC,CAAC;YACA;gBACE,GAAG,EAAE,OAAO;gBACZ,GAAG,EAAE,cAAc;aACpB;SACF,CAAA;AACL,CAAC;AAnBD,wCAmBC"}

package/dist/collections/build-next-link.d.ts

@@ -0,0 +1,12 @@
+import { Query } from 'express-serve-static-core';
+/**
+ * @param hasMore
+ * @param page
+ * @param nextPage
+ * @param collectionPath
+ * @param otherParameters
+ */
+export declare function buildNextLink(hasMore: boolean, page: number | string, nextPage: string | undefined, collectionPath: string, otherParameters: Query): {
+    rel: string;
+    uri: string;
+}[];

package/dist/collections/build-next-link.js

@@ -1,23 +1,34 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.buildNextLink = buildNextLink;
-
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildNextLink = void 0;
 /**
  * @param hasMore
- * @param pageInt
+ * @param page
+ * @param nextPage
  * @param collectionPath
  * @param otherParameters
  */
-function buildNextLink(hasMore, pageInt, collectionPath, otherParameters) {
-  return hasMore ? [{
-    rel: 'next',
-    uri: `${collectionPath}?${new URLSearchParams({
-      page: pageInt + 1,
-      ...otherParameters
-    }).toString()}`
-  }] : [];
+function buildNextLink(hasMore, page, nextPage, collectionPath, otherParameters) {
+    var nextPageNumber = (nextPage !== null && nextPage !== void 0 ? nextPage : typeof page === 'number') ? (page + 1).toFixed() : undefined;
+    return hasMore
+        ? [
+            {
+                rel: 'next',
+                uri: "".concat(collectionPath, "?").concat(new URLSearchParams(__assign({ page: nextPageNumber }, otherParameters)).toString())
+            }
+        ]
+        : [];
 }
+exports.buildNextLink = buildNextLink;
 //# sourceMappingURL=build-next-link.js.map

package/dist/collections/build-next-link.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/collections/build-next-link.js"],"names":["buildNextLink","hasMore","pageInt","collectionPath","otherParameters","rel","uri","URLSearchParams","page","toString"],"mappings":";;;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACO,SAASA,aAAT,CACLC,OADK,EAELC,OAFK,EAGLC,cAHK,EAILC,eAJK,EAKL;AACA,SAAOH,OAAO,GACV,CACE;AACEI,IAAAA,GAAG,EAAE,MADP;AAEEC,IAAAA,GAAG,EAAG,GAAEH,cAAe,IAAG,IAAII,eAAJ,CAAoB;AAC5CC,MAAAA,IAAI,EAAEN,OAAO,GAAG,CAD4B;AAE5C,SAAGE;AAFyC,KAApB,EAGvBK,QAHuB,EAGZ;AALhB,GADF,CADU,GAUV,EAVJ;AAWD","sourcesContent":["/**\n * @param hasMore\n * @param pageInt\n * @param collectionPath\n * @param otherParameters\n */\nexport function buildNextLink (\n  hasMore,\n  pageInt,\n  collectionPath,\n  otherParameters\n) {\n  return hasMore\n    ? [\n        {\n          rel: 'next',\n          uri: `${collectionPath}?${new URLSearchParams({\n            page: pageInt + 1,\n            ...otherParameters\n          }).toString()}`\n        }\n      ]\n    : []\n}\n"],"file":"build-next-link.js"}
+{"version":3,"file":"build-next-link.js","sourceRoot":"","sources":["../../src/collections/build-next-link.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAEA;;;;;;GAMG;AACH,SAAgB,aAAa,CAC3B,OAAgB,EAChB,IAAqB,EACrB,QAA4B,EAC5B,cAAsB,EACtB,eAAsB;IAEtB,IAAM,cAAc,GAAG,CAAA,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,OAAO,IAAI,KAAK,QAAQ,EAAC,CAAC,CAAC,CAAE,IAAe,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;IAC1G,OAAO,OAAO;QACZ,CAAC,CAAC;YACA;gBACE,GAAG,EAAE,MAAM;gBACX,GAAG,EAAE,UAAG,cAAc,cAAI,IAAI,eAAe,YAC3C,IAAI,EAAE,cAAc,IACjB,eAAe,EAClB,CAAC,QAAQ,EAAE,CAAE;aAChB;SACF;QACD,CAAC,CAAC,EAAE,CAAA;AACR,CAAC;AAnBD,sCAmBC"}

package/dist/collections/build-previous-link.d.ts

@@ -0,0 +1,13 @@
+import { Query } from 'express-serve-static-core';
+/**
+ * @param pageInt
+ * @param page
+ * @param prevPage
+ * @param previousPage
+ * @param collectionPath
+ * @param otherParameters
+ */
+export declare function buildPreviousLink(page: number | string, previousPage: string | undefined, collectionPath: string, otherParameters: Query): {
+    rel: string;
+    uri: string;
+}[];

package/dist/collections/build-previous-link.js

@@ -1,35 +1,60 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.buildPreviousLink = buildPreviousLink;
-
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildPreviousLink = void 0;
 /**
  * @param pageInt
+ * @param page
+ * @param prevPage
+ * @param previousPage
  * @param collectionPath
  * @param otherParameters
  */
-function buildPreviousLink(pageInt, collectionPath, otherParameters) {
-  if (pageInt === 1) {
-    return Object.keys(otherParameters).length > 0 ? [{
-      rel: 'prev',
-      uri: `${collectionPath}?${new URLSearchParams({ ...otherParameters
-      }).toString()}`
-    }] : [{
-      rel: 'prev',
-      uri: collectionPath
-    }];
-  } else if (pageInt > 1) {
-    return [{
-      rel: 'prev',
-      uri: `${collectionPath}?${new URLSearchParams({
-        page: pageInt - 1,
-        ...otherParameters
-      }).toString()}`
-    }];
-  } else {
-    return [];
-  }
+function buildPreviousLink(page, previousPage, collectionPath, otherParameters) {
+    if (page === 1) {
+        return Object.keys(otherParameters).length > 0
+            ? [
+                {
+                    rel: 'prev',
+                    uri: "".concat(collectionPath, "?").concat(new URLSearchParams(__assign({}, otherParameters)).toString())
+                }
+            ]
+            : [
+                {
+                    rel: 'prev',
+                    uri: collectionPath
+                }
+            ];
+    }
+    else if (typeof page === 'number' && page > 1) {
+        return [
+            {
+                rel: 'prev',
+                uri: "".concat(collectionPath, "?").concat(new URLSearchParams(__assign({ page: (page - 1).toFixed() }, otherParameters)).toString())
+            }
+        ];
+    }
+    else if (previousPage !== undefined) {
+        return [
+            {
+                rel: 'prev',
+                uri: "".concat(collectionPath, "?").concat(new URLSearchParams(__assign({ page: previousPage }, otherParameters)).toString())
+            }
+        ];
+    }
+    else {
+        return [];
+    }
 }
+exports.buildPreviousLink = buildPreviousLink;
 //# sourceMappingURL=build-previous-link.js.map

package/dist/collections/build-previous-link.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/collections/build-previous-link.js"],"names":["buildPreviousLink","pageInt","collectionPath","otherParameters","Object","keys","length","rel","uri","URLSearchParams","toString","page"],"mappings":";;;;;;;AAAA;AACA;AACA;AACA;AACA;AACO,SAASA,iBAAT,CAA4BC,OAA5B,EAAqCC,cAArC,EAAqDC,eAArD,EAAsE;AAC3E,MAAIF,OAAO,KAAK,CAAhB,EAAmB;AACjB,WAAOG,MAAM,CAACC,IAAP,CAAYF,eAAZ,EAA6BG,MAA7B,GAAsC,CAAtC,GACH,CACE;AACEC,MAAAA,GAAG,EAAE,MADP;AAEEC,MAAAA,GAAG,EAAG,GAAEN,cAAe,IAAG,IAAIO,eAAJ,CAAoB,EAC5C,GAAGN;AADyC,OAApB,EAEvBO,QAFuB,EAEZ;AAJhB,KADF,CADG,GASH,CACE;AACEH,MAAAA,GAAG,EAAE,MADP;AAEEC,MAAAA,GAAG,EAAEN;AAFP,KADF,CATJ;AAeD,GAhBD,MAgBO,IAAID,OAAO,GAAG,CAAd,EAAiB;AACtB,WAAO,CACL;AACEM,MAAAA,GAAG,EAAE,MADP;AAEEC,MAAAA,GAAG,EAAG,GAAEN,cAAe,IAAG,IAAIO,eAAJ,CAAoB;AAC5CE,QAAAA,IAAI,EAAEV,OAAO,GAAG,CAD4B;AAE5C,WAAGE;AAFyC,OAApB,EAGvBO,QAHuB,EAGZ;AALhB,KADK,CAAP;AASD,GAVM,MAUA;AACL,WAAO,EAAP;AACD;AACF","sourcesContent":["/**\n * @param pageInt\n * @param collectionPath\n * @param otherParameters\n */\nexport function buildPreviousLink (pageInt, collectionPath, otherParameters) {\n  if (pageInt === 1) {\n    return Object.keys(otherParameters).length > 0\n      ? [\n          {\n            rel: 'prev',\n            uri: `${collectionPath}?${new URLSearchParams({\n              ...otherParameters\n            }).toString()}`\n          }\n        ]\n      : [\n          {\n            rel: 'prev',\n            uri: collectionPath\n          }\n        ]\n  } else if (pageInt > 1) {\n    return [\n      {\n        rel: 'prev',\n        uri: `${collectionPath}?${new URLSearchParams({\n          page: pageInt - 1,\n          ...otherParameters\n        }).toString()}`\n      }\n    ]\n  } else {\n    return []\n  }\n}\n"],"file":"build-previous-link.js"}
+{"version":3,"file":"build-previous-link.js","sourceRoot":"","sources":["../../src/collections/build-previous-link.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAEA;;;;;;;GAOG;AACH,SAAgB,iBAAiB,CAC/B,IAAqB,EACrB,YAAgC,EAChC,cAAsB,EACtB,eAAsB;IAEtB,IAAI,IAAI,KAAK,CAAC,EAAE;QACd,OAAO,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,GAAG,CAAC;YAC5C,CAAC,CAAC;gBACA;oBACE,GAAG,EAAE,MAAM;oBACX,GAAG,EAAE,UAAG,cAAc,cAAI,IAAI,eAAe,cACxC,eAAyC,EAC5C,CAAC,QAAQ,EAAE,CAAE;iBAChB;aACF;YACD,CAAC,CAAC;gBACA;oBACE,GAAG,EAAE,MAAM;oBACX,GAAG,EAAE,cAAc;iBACpB;aACF,CAAA;KACJ;SAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,GAAG,CAAC,EAAE;QAC/C,OAAO;YACL;gBACE,GAAG,EAAE,MAAM;gBACX,GAAG,EAAE,UAAG,cAAc,cAAI,IAAI,eAAe,YAC3C,IAAI,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,IACvB,eAAe,EAClB,CAAC,QAAQ,EAAE,CAAE;aAChB;SACF,CAAA;KACF;SAAM,IAAI,YAAY,KAAK,SAAS,EAAE;QACrC,OAAO;YACL;gBACE,GAAG,EAAE,MAAM;gBACX,GAAG,EAAE,UAAG,cAAc,cAAI,IAAI,eAAe,YAC3C,IAAI,EAAE,YAAY,IACf,eAAe,EAClB,CAAC,QAAQ,EAAE,CAAE;aAChB;SACF,CAAA;KACF;SAAM;QACL,OAAO,EAAE,CAAA;KACV;AACH,CAAC;AA7CD,8CA6CC"}

package/dist/collections/built-item-links.d.ts

@@ -0,0 +1,16 @@
+import { ItemActions } from '../action';
+import { EndPoint } from '../waycharter';
+import { Link } from '../link';
+/**
+ * @param array
+ * @param arrayPointer
+ * @param collectionPointer
+ * @param itemEndPoint
+ * @param collectionPath
+ * @param selfUri
+ * @param itemActions
+ */
+export declare function builtItemLinks<ItemResponseBody, CanonicalItemActionResponseBody>(collectionPointer: string, itemEndPoint: EndPoint<ItemResponseBody, CanonicalItemActionResponseBody>, selfUri: string, itemActions: ItemActions<CanonicalItemActionResponseBody>): {
+    itemLinks: Link[];
+    canonicalLinks: Link[];
+};

package/dist/collections/built-item-links.js

@@ -1,131 +1,97 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.builtItemLinks = builtItemLinks;
-
-var _uriTemplateLite = require("uri-template-lite");
-
-var _methodCanHaveBody = require("../method-can-have-body");
-
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.builtItemLinks = void 0;
+var to_links_1 = require("../to-links");
 /**
  * @param array
  * @param arrayPointer
- * @param itemType
+ * @param collectionPointer
+ * @param itemEndPoint
  * @param collectionPath
  * @param selfUri
- * @param itemOperations
+ * @param itemActions
  */
-function builtItemLinks(array, arrayPointer, itemType, selfUri, itemOperations) {
-  const itemLinks = [];
-  const canonicalLinks = [];
-
-  if (array.length === 1) {
-    itemLinks.push({
-      rel: 'item',
-      uri: `${selfUri}#${arrayPointer || ''}/0`
-    });
-
-    if (itemType) {
-      canonicalLinks.push({
-        rel: 'canonical',
-        uri: itemType.path(array[0]),
-        anchor: `#${arrayPointer || ''}/0`
-      });
-    }
-
-    if (itemOperations) {
-      for (const relationship in itemOperations) {
-        const endpoint = itemOperations[relationship];
-        itemLinks.push(buildLink({
-          rel: relationship,
-          uri: endpoint.path(array[0]),
-          anchor: `#${arrayPointer || ''}/0`,
-          endpoint,
-          array,
-          arrayPointer
-        }));
-      }
-    }
-  } else if (array.length > 0) {
+function builtItemLinks(collectionPointer, itemEndPoint, selfUri, itemActions) {
+    console.log({ collectionPointer: collectionPointer, itemEndPoint: itemEndPoint, selfUri: selfUri, itemActions: itemActions });
+    var itemLinks = [];
+    var canonicalLinks = [];
     itemLinks.push({
-      rel: 'item',
-      uri: `${selfUri}#${arrayPointer || ''}/{[0..${array.length - 1}]}`
+        rel: 'item',
+        uri: "#".concat(collectionPointer)
     });
-
-    if (itemType) {
-      let pathTemplate = itemType.pathTemplate + '';
-      const template = new _uriTemplateLite.URI.Template(itemType.pathTemplate);
-      const parameters = template.match(itemType.pathTemplate);
-      Object.keys(parameters).forEach(key => {
-        pathTemplate = pathTemplate.replace(parameters[key], `{this.${key}}`);
-      });
-      canonicalLinks.push({
-        rel: 'canonical',
-        uri: pathTemplate,
-        anchor: `#${arrayPointer || ''}/{[0..${array.length - 1}]}`
-      });
-    }
-
-    if (itemOperations) {
-      for (const relationship in itemOperations) {
-        const endpoint = itemOperations[relationship];
-        let pathTemplate = endpoint.pathTemplate + '';
-        const template = new _uriTemplateLite.URI.Template(endpoint.pathTemplate);
-        const parameters = template.match(endpoint.pathTemplate);
-        Object.keys(parameters).forEach(key => {
-          pathTemplate = pathTemplate.replace(parameters[key], `{this.${key}}`);
+    if (itemEndPoint) {
+        console.log({
+            linkTo: {
+                rel: 'canonical',
+                uri: itemEndPoint.pathTemplate,
+                anchor: "#".concat(collectionPointer)
+            }
+        });
+        canonicalLinks.push({
+            rel: 'canonical',
+            uri: itemEndPoint.pathTemplate,
+            anchor: "#".concat(collectionPointer)
         });
-        itemLinks.push(buildLink({
-          rel: relationship,
-          uri: pathTemplate,
-          anchor: `#${arrayPointer || ''}/{[0..${array.length - 1}]}`,
-          endpoint,
-          array,
-          arrayPointer
-        }));
-      }
     }
-  }
-
-  return {
-    itemLinks,
-    canonicalLinks
-  };
-}
-/**
- * @param root0
- * @param root0.rel
- * @param root0.uri
- * @param root0.anchor
- * @param root0.endpoint
- * @param root0.array
- * @param root0.arrayPointer
- */
-
-
-function buildLink({
-  rel,
-  uri,
-  anchor,
-  endpoint,
-  array,
-  arrayPointer
-}) {
-  return {
-    rel,
-    uri,
-    anchor,
-    ...(endpoint.method && {
-      method: endpoint.method
-    }),
-    ...((endpoint.parameters || endpoint.bodyParameters) && {
-      parameters: endpoint.parameters || endpoint.bodyParameters
-    }),
-    ...((0, _methodCanHaveBody.methodCanHaveBody)(endpoint.method) && {
-      accept: ['application/x-www-form-urlencoded', 'application/json', 'multipart/form-data']
-    })
-  };
+    if (itemActions) {
+        itemLinks.push.apply(itemLinks, __spreadArray([], __read((0, to_links_1.toLinks)(itemActions, selfUri, function (action) {
+            var anchor = action.anchor, accept = action.accept, other = __rest(action, ["anchor", "accept"]);
+            return __assign(__assign({}, other), { anchor: "#".concat(collectionPointer), accept: accept || [
+                    'application/json',
+                    'application/x-www-form-urlencoded',
+                    'multipart/form-data'
+                ] // TODO: allow caller to specify accept
+             });
+        })), false));
+    }
+    return { itemLinks: itemLinks, canonicalLinks: canonicalLinks };
 }
+exports.builtItemLinks = builtItemLinks;
 //# sourceMappingURL=built-item-links.js.map

package/dist/collections/built-item-links.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/collections/built-item-links.js"],"names":["builtItemLinks","array","arrayPointer","itemType","selfUri","itemOperations","itemLinks","canonicalLinks","length","push","rel","uri","path","anchor","relationship","endpoint","buildLink","pathTemplate","template","URI","Template","parameters","match","Object","keys","forEach","key","replace","method","bodyParameters","accept"],"mappings":";;;;;;;AAAA;;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASA,cAAT,CACLC,KADK,EAELC,YAFK,EAGLC,QAHK,EAILC,OAJK,EAKLC,cALK,EAML;AACA,QAAMC,SAAS,GAAG,EAAlB;AACA,QAAMC,cAAc,GAAG,EAAvB;;AACA,MAAIN,KAAK,CAACO,MAAN,KAAiB,CAArB,EAAwB;AACtBF,IAAAA,SAAS,CAACG,IAAV,CAAe;AACbC,MAAAA,GAAG,EAAE,MADQ;AAEbC,MAAAA,GAAG,EAAG,GAAEP,OAAQ,IAAGF,YAAY,IAAI,EAAG;AAFzB,KAAf;;AAIA,QAAIC,QAAJ,EAAc;AACZI,MAAAA,cAAc,CAACE,IAAf,CAAoB;AAClBC,QAAAA,GAAG,EAAE,WADa;AAElBC,QAAAA,GAAG,EAAER,QAAQ,CAACS,IAAT,CAAcX,KAAK,CAAC,CAAD,CAAnB,CAFa;AAGlBY,QAAAA,MAAM,EAAG,IAAGX,YAAY,IAAI,EAAG;AAHb,OAApB;AAKD;;AACD,QAAIG,cAAJ,EAAoB;AAClB,WAAK,MAAMS,YAAX,IAA2BT,cAA3B,EAA2C;AACzC,cAAMU,QAAQ,GAAGV,cAAc,CAACS,YAAD,CAA/B;AACAR,QAAAA,SAAS,CAACG,IAAV,CACEO,SAAS,CAAC;AACRN,UAAAA,GAAG,EAAEI,YADG;AAERH,UAAAA,GAAG,EAAEI,QAAQ,CAACH,IAAT,CAAcX,KAAK,CAAC,CAAD,CAAnB,CAFG;AAGRY,UAAAA,MAAM,EAAG,IAAGX,YAAY,IAAI,EAAG,IAHvB;AAIRa,UAAAA,QAJQ;AAKRd,UAAAA,KALQ;AAMRC,UAAAA;AANQ,SAAD,CADX;AAUD;AACF;AACF,GA3BD,MA2BO,IAAID,KAAK,CAACO,MAAN,GAAe,CAAnB,EAAsB;AAC3BF,IAAAA,SAAS,CAACG,IAAV,CAAe;AACbC,MAAAA,GAAG,EAAE,MADQ;AAEbC,MAAAA,GAAG,EAAG,GAAEP,OAAQ,IAAGF,YAAY,IAAI,EAAG,SAAQD,KAAK,CAACO,MAAN,GAAe,CAAE;AAFlD,KAAf;;AAIA,QAAIL,QAAJ,EAAc;AACZ,UAAIc,YAAY,GAAGd,QAAQ,CAACc,YAAT,GAAwB,EAA3C;AACA,YAAMC,QAAQ,GAAG,IAAIC,qBAAIC,QAAR,CAAiBjB,QAAQ,CAACc,YAA1B,CAAjB;AACA,YAAMI,UAAU,GAAGH,QAAQ,CAACI,KAAT,CAAenB,QAAQ,CAACc,YAAxB,CAAnB;AACAM,MAAAA,MAAM,CAACC,IAAP,CAAYH,UAAZ,EAAwBI,OAAxB,CAAgCC,GAAG,IAAI;AACrCT,QAAAA,YAAY,GAAGA,YAAY,CAACU,OAAb,CAAqBN,UAAU,CAACK,GAAD,CAA/B,EAAuC,SAAQA,GAAI,GAAnD,CAAf;AACD,OAFD;AAGAnB,MAAAA,cAAc,CAACE,IAAf,CAAoB;AAClBC,QAAAA,GAAG,EAAE,WADa;AAElBC,QAAAA,GAAG,EAAEM,YAFa;AAGlBJ,QAAAA,MAAM,EAAG,IAAGX,YAAY,IAAI,EAAG,SAAQD,KAAK,CAACO,MAAN,GAAe,CAAE;AAHtC,OAApB;AAKD;;AACD,QAAIH,cAAJ,EAAoB;AAClB,WAAK,MAAMS,YAAX,IAA2BT,cAA3B,EAA2C;AACzC,cAAMU,QAAQ,GAAGV,cAAc,CAACS,YAAD,CAA/B;AACA,YAAIG,YAAY,GAAGF,QAAQ,CAACE,YAAT,GAAwB,EAA3C;AACA,cAAMC,QAAQ,GAAG,IAAIC,qBAAIC,QAAR,CAAiBL,QAAQ,CAACE,YAA1B,CAAjB;AACA,cAAMI,UAAU,GAAGH,QAAQ,CAACI,KAAT,CAAeP,QAAQ,CAACE,YAAxB,CAAnB;AACAM,QAAAA,MAAM,CAACC,IAAP,CAAYH,UAAZ,EAAwBI,OAAxB,CAAgCC,GAAG,IAAI;AACrCT,UAAAA,YAAY,GAAGA,YAAY,CAACU,OAAb,CAAqBN,UAAU,CAACK,GAAD,CAA/B,EAAuC,SAAQA,GAAI,GAAnD,CAAf;AACD,SAFD;AAGApB,QAAAA,SAAS,CAACG,IAAV,CACEO,SAAS,CAAC;AACRN,UAAAA,GAAG,EAAEI,YADG;AAERH,UAAAA,GAAG,EAAEM,YAFG;AAGRJ,UAAAA,MAAM,EAAG,IAAGX,YAAY,IAAI,EAAG,SAAQD,KAAK,CAACO,MAAN,GAAe,CAAE,IAHhD;AAIRO,UAAAA,QAJQ;AAKRd,UAAAA,KALQ;AAMRC,UAAAA;AANQ,SAAD,CADX;AAUD;AACF;AACF;;AACD,SAAO;AAAEI,IAAAA,SAAF;AAAaC,IAAAA;AAAb,GAAP;AACD;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACA,SAASS,SAAT,CAAoB;AAAEN,EAAAA,GAAF;AAAOC,EAAAA,GAAP;AAAYE,EAAAA,MAAZ;AAAoBE,EAAAA,QAApB;AAA8Bd,EAAAA,KAA9B;AAAqCC,EAAAA;AAArC,CAApB,EAAyE;AACvE,SAAO;AACLQ,IAAAA,GADK;AAELC,IAAAA,GAFK;AAGLE,IAAAA,MAHK;AAIL,QAAIE,QAAQ,CAACa,MAAT,IAAmB;AAAEA,MAAAA,MAAM,EAAEb,QAAQ,CAACa;AAAnB,KAAvB,CAJK;AAKL,QAAI,CAACb,QAAQ,CAACM,UAAT,IAAuBN,QAAQ,CAACc,cAAjC,KAAoD;AACtDR,MAAAA,UAAU,EAAEN,QAAQ,CAACM,UAAT,IAAuBN,QAAQ,CAACc;AADU,KAAxD,CALK;AAQL,QAAI,0CAAkBd,QAAQ,CAACa,MAA3B,KAAsC;AACxCE,MAAAA,MAAM,EAAE,CACN,mCADM,EAEN,kBAFM,EAGN,qBAHM;AADgC,KAA1C;AARK,GAAP;AAgBD","sourcesContent":["import { URI } from 'uri-template-lite'\nimport { methodCanHaveBody } from '../method-can-have-body'\n\n/**\n * @param array\n * @param arrayPointer\n * @param itemType\n * @param collectionPath\n * @param selfUri\n * @param itemOperations\n */\nexport function builtItemLinks (\n  array,\n  arrayPointer,\n  itemType,\n  selfUri,\n  itemOperations\n) {\n  const itemLinks = []\n  const canonicalLinks = []\n  if (array.length === 1) {\n    itemLinks.push({\n      rel: 'item',\n      uri: `${selfUri}#${arrayPointer || ''}/0`\n    })\n    if (itemType) {\n      canonicalLinks.push({\n        rel: 'canonical',\n        uri: itemType.path(array[0]),\n        anchor: `#${arrayPointer || ''}/0`\n      })\n    }\n    if (itemOperations) {\n      for (const relationship in itemOperations) {\n        const endpoint = itemOperations[relationship]\n        itemLinks.push(\n          buildLink({\n            rel: relationship,\n            uri: endpoint.path(array[0]),\n            anchor: `#${arrayPointer || ''}/0`,\n            endpoint,\n            array,\n            arrayPointer\n          })\n        )\n      }\n    }\n  } else if (array.length > 0) {\n    itemLinks.push({\n      rel: 'item',\n      uri: `${selfUri}#${arrayPointer || ''}/{[0..${array.length - 1}]}`\n    })\n    if (itemType) {\n      let pathTemplate = itemType.pathTemplate + ''\n      const template = new URI.Template(itemType.pathTemplate)\n      const parameters = template.match(itemType.pathTemplate)\n      Object.keys(parameters).forEach(key => {\n        pathTemplate = pathTemplate.replace(parameters[key], `{this.${key}}`)\n      })\n      canonicalLinks.push({\n        rel: 'canonical',\n        uri: pathTemplate,\n        anchor: `#${arrayPointer || ''}/{[0..${array.length - 1}]}`\n      })\n    }\n    if (itemOperations) {\n      for (const relationship in itemOperations) {\n        const endpoint = itemOperations[relationship]\n        let pathTemplate = endpoint.pathTemplate + ''\n        const template = new URI.Template(endpoint.pathTemplate)\n        const parameters = template.match(endpoint.pathTemplate)\n        Object.keys(parameters).forEach(key => {\n          pathTemplate = pathTemplate.replace(parameters[key], `{this.${key}}`)\n        })\n        itemLinks.push(\n          buildLink({\n            rel: relationship,\n            uri: pathTemplate,\n            anchor: `#${arrayPointer || ''}/{[0..${array.length - 1}]}`,\n            endpoint,\n            array,\n            arrayPointer\n          })\n        )\n      }\n    }\n  }\n  return { itemLinks, canonicalLinks }\n}\n/**\n * @param root0\n * @param root0.rel\n * @param root0.uri\n * @param root0.anchor\n * @param root0.endpoint\n * @param root0.array\n * @param root0.arrayPointer\n */\nfunction buildLink ({ rel, uri, anchor, endpoint, array, arrayPointer }) {\n  return {\n    rel,\n    uri,\n    anchor,\n    ...(endpoint.method && { method: endpoint.method }),\n    ...((endpoint.parameters || endpoint.bodyParameters) && {\n      parameters: endpoint.parameters || endpoint.bodyParameters\n    }),\n    ...(methodCanHaveBody(endpoint.method) && {\n      accept: [\n        'application/x-www-form-urlencoded',\n        'application/json',\n        'multipart/form-data'\n      ]\n    })\n  }\n}\n"],"file":"built-item-links.js"}
+{"version":3,"file":"built-item-links.js","sourceRoot":"","sources":["../../src/collections/built-item-links.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,wCAAqC;AAKrC;;;;;;;;GAQG;AACH,SAAgB,cAAc,CAC5B,iBAAyB,EACzB,YAAyE,EACzE,OAAe,EACf,WAAyD;IAIzD,OAAO,CAAC,GAAG,CAAC,EAAE,iBAAiB,mBAAA,EAAE,YAAY,cAAA,EAAE,OAAO,SAAA,EAAE,WAAW,aAAA,EAAE,CAAC,CAAA;IACtE,IAAM,SAAS,GAAG,EAAE,CAAA;IACpB,IAAM,cAAc,GAAG,EAAE,CAAA;IACzB,SAAS,CAAC,IAAI,CAAC;QACb,GAAG,EAAE,MAAM;QACX,GAAG,EAAE,WAAI,iBAAiB,CAAE;KAC7B,CAAC,CAAA;IACF,IAAI,YAAY,EAAE;QAChB,OAAO,CAAC,GAAG,CAAC;YACV,MAAM,EAAE;gBACN,GAAG,EAAE,WAAW;gBAChB,GAAG,EAAE,YAAY,CAAC,YAAY;gBAC9B,MAAM,EAAE,WAAI,iBAAiB,CAAE;aAChC;SACF,CAAC,CAAA;QACF,cAAc,CAAC,IAAI,CAAC;YAClB,GAAG,EAAE,WAAW;YAChB,GAAG,EAAE,YAAY,CAAC,YAAY;YAC9B,MAAM,EAAE,WAAI,iBAAiB,CAAE;SAChC,CAAC,CAAA;KACH;IACD,IAAI,WAAW,EAAE;QACf,SAAS,CAAC,IAAI,OAAd,SAAS,2BACJ,IAAA,kBAAO,EAAC,WAAW,EAAE,OAAO,EAAE,UAAA,MAAM;YAC7B,IAAA,MAAM,GAAuB,MAAM,OAA7B,EAAE,MAAM,GAAe,MAAM,OAArB,EAAK,KAAK,UAAK,MAAM,EAArC,oBAA4B,CAAF,CAAW;YAC3C,6BACK,KAAK,KACR,MAAM,EAAE,WAAI,iBAAiB,CAAE,EAC/B,MAAM,EAAE,MAAM,IAAI;oBAChB,kBAAkB;oBAClB,mCAAmC;oBACnC,qBAAqB;iBACtB,CAAC,uCAAuC;gBAC1C;QACH,CAAC,CAAC,WACH;KACF;IACD,OAAO,EAAE,SAAS,WAAA,EAAE,cAAc,gBAAA,EAAE,CAAA;AACtC,CAAC;AA9CD,wCA8CC"}

package/dist/handler.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="node" />
+import express from 'express';
+import { Query, ParamsDictionary } from 'express-serve-static-core';
+import { IncomingHttpHeaders } from 'http';
+export declare type HandlerParameters<ResponseBody> = {
+    pathParameters: ParamsDictionary;
+    queryParameters: Query;
+    requestHeaders: IncomingHttpHeaders;
+    request: express.Request;
+    response: express.Response<ResponseBody>;
+    next: express.NextFunction;
+};
+export declare type Handler<ResponseBody> = (parameters: HandlerParameters<ResponseBody>) => Promise<void> | void;
+export declare type CollectionHandlerParameters<ResponseBody> = HandlerParameters<ResponseBody> & {
+    page: number | string;
+};
+export declare type CollectionHandler<ResponseBody> = (parameters: CollectionHandlerParameters<ResponseBody>) => Promise<void> | void;
+export declare type ActionHandlerParameters<ResponseBody> = Omit<HandlerParameters<ResponseBody>, 'requestHeaders'> & {
+    bodyParameters: Record<string, unknown>;
+};
+export declare type ActionHandler<ResponseBody> = (parameters: ActionHandlerParameters<ResponseBody>) => Promise<void> | void;

package/dist/handler.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=handler.js.map

package/dist/handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"handler.js","sourceRoot":"","sources":["../src/handler.ts"],"names":[],"mappings":""}

package/dist/link.d.ts

@@ -0,0 +1,17 @@
+import { Method } from './method';
+export declare type BaseLink = {
+    rel: string;
+    uri: string;
+    anchor?: string;
+    hreflang?: string;
+    media?: string;
+    title?: string;
+    'title*'?: string;
+    type?: string;
+    parameters?: Array<string> | {
+        [key: string]: {};
+    };
+    accept?: Array<string>;
+    method?: Method;
+};
+export declare type Link = BaseLink & Record<string, any>;