@clipboard-health/util-ts 0.7.4 → 0.9.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [0.9.0](https://github.com/ClipboardHealth/cbh-core/compare/util-ts-0.8.0...util-ts-0.9.0) (2023-08-14)
+
+
+### Features
+
+* add typed API relationships, add pagination and API error examples ([#256](https://github.com/ClipboardHealth/cbh-core/issues/256)) ([81377e3](https://github.com/ClipboardHealth/cbh-core/commit/81377e357af447c764ed668196a5c025e35aff35))
+
+## [0.8.0](https://github.com/ClipboardHealth/cbh-core/compare/util-ts-0.7.4...util-ts-0.8.0) (2023-08-10)
+
+
+### Features
+
+* add API errors with helpers to create them from CbhError ([#252](https://github.com/ClipboardHealth/cbh-core/issues/252)) ([0efb42a](https://github.com/ClipboardHealth/cbh-core/commit/0efb42a9ef44831bf08b05a6ae19a55cfc38742a))
+
 ## [0.7.4](https://github.com/ClipboardHealth/cbh-core/compare/util-ts-0.7.3...util-ts-0.7.4) (2023-07-12)
 
 ## [0.7.3](https://github.com/ClipboardHealth/cbh-core/compare/util-ts-0.7.2...util-ts-0.7.3) (2023-07-10)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clipboard-health/util-ts",
-  "version": "0.7.4",
+  "version": "0.9.0",
   "main": "./src/index.js",
   "scripts": {
     "build": "nx build util-ts",

package/src/index.d.ts

@@ -2,6 +2,7 @@ export * from "./lib/cbh-error";
 export * from "./lib/cbh-response";
 export * from "./lib/defined-utils";
 export * from "./lib/force-cast";
+export * from "./lib/head";
 export * from "./lib/is-string";
 export * from "./lib/non-empty-array";
 export * from "./lib/stringify";

package/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/util-ts/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/util-ts/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC"}

package/src/index.js

@@ -1,12 +1,26 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./lib/cbh-error"), exports);
-tslib_1.__exportStar(require("./lib/cbh-response"), exports);
-tslib_1.__exportStar(require("./lib/defined-utils"), exports);
-tslib_1.__exportStar(require("./lib/force-cast"), exports);
-tslib_1.__exportStar(require("./lib/is-string"), exports);
-tslib_1.__exportStar(require("./lib/non-empty-array"), exports);
-tslib_1.__exportStar(require("./lib/stringify"), exports);
-tslib_1.__exportStar(require("./lib/to-error"), exports);
+__exportStar(require("./lib/cbh-error"), exports);
+__exportStar(require("./lib/cbh-response"), exports);
+__exportStar(require("./lib/defined-utils"), exports);
+__exportStar(require("./lib/force-cast"), exports);
+__exportStar(require("./lib/head"), exports);
+__exportStar(require("./lib/is-string"), exports);
+__exportStar(require("./lib/non-empty-array"), exports);
+__exportStar(require("./lib/stringify"), exports);
+__exportStar(require("./lib/to-error"), exports);
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/util-ts/src/index.ts"],"names":[],"mappings":";;;AAAA,0DAAgC;AAChC,6DAAmC;AACnC,8DAAoC;AACpC,2DAAiC;AACjC,0DAAgC;AAChC,gEAAsC;AACtC,0DAAgC;AAChC,yDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/util-ts/src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,qDAAmC;AACnC,sDAAoC;AACpC,mDAAiC;AACjC,6CAA2B;AAC3B,kDAAgC;AAChC,wDAAsC;AACtC,kDAAgC;AAChC,iDAA+B"}

package/src/lib/cbh-error.d.ts

@@ -1,10 +1,15 @@
-import { type NonEmptyArray, type OneOrNonEmptyArray } from "./non-empty-array";
+import { type OneOrNonEmptyArray } from "./non-empty-array";
+declare const ERROR_STATUS_CODES: readonly [400, 401, 403, 404, 409, 429, 500];
+export type ErrorStatusCode = (typeof ERROR_STATUS_CODES)[number];
 export interface CbhIssue {
     cause?: Error;
+    id?: string;
     message: string;
+    statusCode?: ErrorStatusCode;
 }
 export declare class CbhError extends Error {
-    readonly issues: NonEmptyArray<CbhIssue>;
+    readonly issues: CbhIssue[];
     constructor(issues: OneOrNonEmptyArray<CbhIssue>);
 }
+export {};
 //# sourceMappingURL=cbh-error.d.ts.map

package/src/lib/cbh-error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cbh-error.d.ts","sourceRoot":"","sources":["../../../../../packages/util-ts/src/lib/cbh-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,kBAAkB,EAAmB,MAAM,mBAAmB,CAAC;AAEjG,MAAM,WAAW,QAAQ;IACvB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,qBAAa,QAAS,SAAQ,KAAK;IACjC,SAAgB,MAAM,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;gBAEpC,MAAM,EAAE,kBAAkB,CAAC,QAAQ,CAAC;CASjD"}
+{"version":3,"file":"cbh-error.d.ts","sourceRoot":"","sources":["../../../../../packages/util-ts/src/lib/cbh-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,kBAAkB,EAAmB,MAAM,mBAAmB,CAAC;AAE7E,QAAA,MAAM,kBAAkB,8CAA+C,CAAC;AACxE,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;AAElE,MAAM,WAAW,QAAQ;IACvB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,eAAe,CAAC;CAC9B;AAED,qBAAa,QAAS,SAAQ,KAAK;IACjC,SAAgB,MAAM,EAAE,QAAQ,EAAE,CAAC;gBAEvB,MAAM,EAAE,kBAAkB,CAAC,QAAQ,CAAC;CAUjD"}

package/src/lib/cbh-error.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CbhError = void 0;
 const non_empty_array_1 = require("./non-empty-array");
+const ERROR_STATUS_CODES = [400, 401, 403, 404, 409, 429, 500];
 class CbhError extends Error {
     issues;
     constructor(issues) {

package/src/lib/cbh-error.js.map

@@ -1 +1 @@
-{"version":3,"file":"cbh-error.js","sourceRoot":"","sources":["../../../../../packages/util-ts/src/lib/cbh-error.ts"],"names":[],"mappings":";;;AAAA,uDAAiG;AAOjG,MAAa,QAAS,SAAQ,KAAK;IACjB,MAAM,CAA0B;IAEhD,YAAY,MAAoC;QAC9C,MAAM,EAAE,GAAG,IAAA,iCAAe,EAAC,MAAM,CAAC,CAAC;QACnC,MAAM,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;QACpB,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QAC/C,6FAA6F;QAC7F,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;IACzB,CAAC;CACF;AAZD,4BAYC"}
+{"version":3,"file":"cbh-error.js","sourceRoot":"","sources":["../../../../../packages/util-ts/src/lib/cbh-error.ts"],"names":[],"mappings":";;;AAAA,uDAA6E;AAE7E,MAAM,kBAAkB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAU,CAAC;AAUxE,MAAa,QAAS,SAAQ,KAAK;IACjB,MAAM,CAAa;IAEnC,YAAY,MAAoC;QAC9C,MAAM,EAAE,GAAG,IAAA,iCAAe,EAAC,MAAM,CAAC,CAAC;QACnC,MAAM,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;QACpB,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QAC/C,6FAA6F;QAC7F,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAElD,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;IACzB,CAAC;CACF;AAbD,4BAaC"}

package/src/lib/head.d.ts

@@ -0,0 +1,2 @@
+export declare function head<T>(value?: T | T[]): T | undefined;
+//# sourceMappingURL=head.d.ts.map

package/src/lib/head.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"head.d.ts","sourceRoot":"","sources":["../../../../../packages/util-ts/src/lib/head.ts"],"names":[],"mappings":"AAAA,wBAAgB,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,SAAS,CAEtD"}

package/src/lib/head.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.head = void 0;
+function head(value) {
+    return Array.isArray(value) ? value[0] : value ?? undefined;
+}
+exports.head = head;
+//# sourceMappingURL=head.js.map

package/src/lib/head.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"head.js","sourceRoot":"","sources":["../../../../../packages/util-ts/src/lib/head.ts"],"names":[],"mappings":";;;AAAA,SAAgB,IAAI,CAAI,KAAe;IACrC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,SAAS,CAAC;AAC9D,CAAC;AAFD,oBAEC"}