@clipboard-health/util-ts 2.9.7 → 2.11.0
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/package.json +1 -1
- package/src/lib/errors/serviceError.d.ts +3 -8
- package/src/lib/errors/serviceError.js +9 -5
- package/src/lib/errors/serviceError.js.map +1 -1
- package/src/lib/functional/option.d.ts +8 -0
- package/src/lib/functional/option.js +13 -0
- package/src/lib/functional/option.js.map +1 -1
- package/src/lib/functional/serviceResult.d.ts +2 -0
- package/src/lib/functional/serviceResult.js +6 -0
- package/src/lib/functional/serviceResult.js.map +1 -1
package/package.json
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { type ZodError, type ZodIssue } from "zod";
|
|
1
2
|
/**
|
|
2
3
|
* Standard error codes used across microservices.
|
|
3
4
|
*/
|
|
@@ -28,13 +29,6 @@ export type ServiceErrorParams = string | {
|
|
|
28
29
|
/** Array of issues contributing to the error */
|
|
29
30
|
issues: readonly ServiceIssue[];
|
|
30
31
|
};
|
|
31
|
-
export interface ZodLike {
|
|
32
|
-
name: string;
|
|
33
|
-
issues: ReadonlyArray<{
|
|
34
|
-
message?: string | undefined;
|
|
35
|
-
path: Array<string | number>;
|
|
36
|
-
}>;
|
|
37
|
-
}
|
|
38
32
|
declare const ERROR_METADATA: {
|
|
39
33
|
readonly badRequest: {
|
|
40
34
|
readonly status: 400;
|
|
@@ -92,7 +86,7 @@ export declare class ServiceError extends Error {
|
|
|
92
86
|
* @param value - A ZodError
|
|
93
87
|
* @returns The converted `ServiceError`
|
|
94
88
|
*/
|
|
95
|
-
static fromZodError(value:
|
|
89
|
+
static fromZodError(value: ZodError): ServiceError;
|
|
96
90
|
readonly id: string;
|
|
97
91
|
readonly issues: readonly Issue[];
|
|
98
92
|
readonly status: Status;
|
|
@@ -123,4 +117,5 @@ export declare class ServiceError extends Error {
|
|
|
123
117
|
}[];
|
|
124
118
|
};
|
|
125
119
|
}
|
|
120
|
+
export declare function toZodIssue(issue: ZodIssue): ServiceIssue;
|
|
126
121
|
export {};
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ServiceError = exports.ERROR_CODES = void 0;
|
|
4
|
+
exports.toZodIssue = toZodIssue;
|
|
4
5
|
const node_crypto_1 = require("node:crypto");
|
|
5
6
|
const deepFreeze_1 = require("../deepFreeze");
|
|
6
7
|
const toError_1 = require("./toError");
|
|
@@ -81,11 +82,7 @@ class ServiceError extends Error {
|
|
|
81
82
|
static fromZodError(value) {
|
|
82
83
|
return new ServiceError({
|
|
83
84
|
cause: value,
|
|
84
|
-
issues: value.issues.map(
|
|
85
|
-
code: exports.ERROR_CODES.unprocessableEntity,
|
|
86
|
-
message: issue.message,
|
|
87
|
-
path: issue.path,
|
|
88
|
-
})),
|
|
85
|
+
issues: value.issues.map(toZodIssue),
|
|
89
86
|
});
|
|
90
87
|
}
|
|
91
88
|
id;
|
|
@@ -141,6 +138,13 @@ class ServiceError extends Error {
|
|
|
141
138
|
}
|
|
142
139
|
}
|
|
143
140
|
exports.ServiceError = ServiceError;
|
|
141
|
+
function toZodIssue(issue) {
|
|
142
|
+
return {
|
|
143
|
+
code: exports.ERROR_CODES.unprocessableEntity,
|
|
144
|
+
message: issue.message,
|
|
145
|
+
path: issue.path,
|
|
146
|
+
};
|
|
147
|
+
}
|
|
144
148
|
/**
|
|
145
149
|
* Creates a human-readable error message from an array of service issues
|
|
146
150
|
* @param issues - Array of issues to include in the message
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"serviceError.js","sourceRoot":"","sources":["../../../../../../packages/util-ts/src/lib/errors/serviceError.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"serviceError.js","sourceRoot":"","sources":["../../../../../../packages/util-ts/src/lib/errors/serviceError.ts"],"names":[],"mappings":";;;AAsLA,gCAMC;AA5LD,6CAAyC;AAIzC,8CAA2C;AAC3C,uCAAoC;AAEpC;;GAEG;AACU,QAAA,WAAW,GAAG;IACzB,UAAU,EAAE,YAAY;IACxB,YAAY,EAAE,cAAc;IAC5B,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,UAAU;IACpB,mBAAmB,EAAE,qBAAqB;IAC1C,eAAe,EAAE,iBAAiB;IAClC,QAAQ,EAAE,UAAU;CACZ,CAAC;AA2BX,MAAM,cAAc,GAAG;IACrB,UAAU,EAAE;QACV,MAAM,EAAE,GAAG;QACX,KAAK,EAAE,8BAA8B;KACtC;IACD,YAAY,EAAE;QACZ,MAAM,EAAE,GAAG;QACX,KAAK,EAAE,gCAAgC;KACxC;IACD,SAAS,EAAE;QACT,MAAM,EAAE,GAAG;QACX,KAAK,EAAE,2BAA2B;KACnC;IACD,QAAQ,EAAE;QACR,MAAM,EAAE,GAAG;QACX,KAAK,EAAE,oBAAoB;KAC5B;IACD,QAAQ,EAAE;QACR,MAAM,EAAE,GAAG;QACX,KAAK,EAAE,4BAA4B;KACpC;IACD,mBAAmB,EAAE;QACnB,MAAM,EAAE,GAAG;QACX,KAAK,EAAE,2BAA2B;KACnC;IACD,eAAe,EAAE;QACf,MAAM,EAAE,GAAG;QACX,KAAK,EAAE,wBAAwB;KAChC;IACD,QAAQ,EAAE;QACR,MAAM,EAAE,GAAG;QACX,KAAK,EAAE,uBAAuB;KAC/B;CACsE,CAAC;AAQ1E;;GAEG;AACH,MAAa,YAAa,SAAQ,KAAK;IACrC;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAC,KAAc;QAC/B,IAAI,KAAK,YAAY,YAAY,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,KAAK,GAAG,IAAA,iBAAO,EAAC,KAAK,CAAC,CAAC;QAC7B,OAAO,IAAI,YAAY,CAAC;YACtB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,mBAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;YAChE,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,YAAY,CAAC,KAAe;QACjC,OAAO,IAAI,YAAY,CAAC;YACtB,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC;SACrC,CAAC,CAAC;IACL,CAAC;IAEQ,EAAE,CAAS;IACX,MAAM,CAAmB;IACzB,MAAM,CAAS;IAExB;;;OAGG;IACH,YAAY,UAA8B;QACxC,MAAM,MAAM,GACV,OAAO,UAAU,KAAK,QAAQ;YAC5B,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC,EAAE;YACjF,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;QAChE,KAAK,CAAC,yBAAyB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAEhD,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QACrC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,IAAA,wBAAU,GAAE,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,IAAA,uBAAU,EAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAClC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAW,CAAC;QAE9F;;;WAGG;QACH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACM,QAAQ;QACf,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACH,SAAS;QACP,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBAClC,EAAE,EAAE,IAAI,CAAC,EAAE;gBACX,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;gBACjD,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,GAAG,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;gBAC/C,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI;oBAChB,MAAM,EAAE;wBACN,OAAO,EAAE,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;qBACpC;iBACF,CAAC;aACH,CAAC,CAAC;SACJ,CAAC;IACJ,CAAC;CACF;AA1FD,oCA0FC;AAED,SAAgB,UAAU,CAAC,KAAe;IACxC,OAAO;QACL,IAAI,EAAE,mBAAW,CAAC,mBAAmB;QACrC,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,IAAI,EAAE,KAAK,CAAC,IAAI;KACjB,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAS,yBAAyB,CAAC,MAAwB;IACzD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,OAAO,MAAM;SACV,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACb,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1D,OAAO,IAAI,KAAK,CAAC,IAAI,IAAI,OAAO,EAAE,CAAC;IACrC,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED,SAAS,OAAO,CAAC,KAAmB;IAClC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,mBAAW,CAAC,QAAQ,CAAC;IAChD,OAAO,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;AAC/D,CAAC"}
|
|
@@ -69,3 +69,11 @@ export declare function getOrElse<A>(defaultValue: A): (option: Option<A>) => A;
|
|
|
69
69
|
* @returns The result of either `onNone` or `onSome` based on the `Option` state
|
|
70
70
|
*/
|
|
71
71
|
export declare function match<A, B, C>(onNone: () => B, onSome: (value: A) => C): (option: Option<A>) => B | C;
|
|
72
|
+
/**
|
|
73
|
+
* Converts a nullable value to an `Option`. If the value is `null` or `undefined`, returns `None`.
|
|
74
|
+
* Otherwise, returns `Some(value)`.
|
|
75
|
+
*
|
|
76
|
+
* @param value - The value to convert
|
|
77
|
+
* @returns An `Option` representing the nullable value
|
|
78
|
+
*/
|
|
79
|
+
export declare function fromNullable<A>(value: A | null | undefined): Option<A>;
|
|
@@ -8,6 +8,8 @@ exports.map = map;
|
|
|
8
8
|
exports.flatMap = flatMap;
|
|
9
9
|
exports.getOrElse = getOrElse;
|
|
10
10
|
exports.match = match;
|
|
11
|
+
exports.fromNullable = fromNullable;
|
|
12
|
+
const nullish_1 = require("../nullish");
|
|
11
13
|
/**
|
|
12
14
|
* Constructs an `Option` of `None`, representing a missing value.
|
|
13
15
|
*/
|
|
@@ -79,4 +81,15 @@ function getOrElse(defaultValue) {
|
|
|
79
81
|
function match(onNone, onSome) {
|
|
80
82
|
return (option) => (isSome(option) ? onSome(option.value) : onNone());
|
|
81
83
|
}
|
|
84
|
+
/**
|
|
85
|
+
* Converts a nullable value to an `Option`. If the value is `null` or `undefined`, returns `None`.
|
|
86
|
+
* Otherwise, returns `Some(value)`.
|
|
87
|
+
*
|
|
88
|
+
* @param value - The value to convert
|
|
89
|
+
* @returns An `Option` representing the nullable value
|
|
90
|
+
*/
|
|
91
|
+
// eslint-disable-next-line @typescript-eslint/ban-types
|
|
92
|
+
function fromNullable(value) {
|
|
93
|
+
return (0, nullish_1.isNil)(value) ? exports.none : some(value);
|
|
94
|
+
}
|
|
82
95
|
//# sourceMappingURL=option.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"option.js","sourceRoot":"","sources":["../../../../../../packages/util-ts/src/lib/functional/option.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"option.js","sourceRoot":"","sources":["../../../../../../packages/util-ts/src/lib/functional/option.ts"],"names":[],"mappings":";;;AA8BA,oBAEC;AAQD,wBAEC;AAQD,wBAEC;AASD,kBAEC;AASD,0BAEC;AASD,8BAEC;AASD,sBAKC;AAUD,oCAEC;AA/GD,wCAAmC;AAmBnC;;GAEG;AACU,QAAA,IAAI,GAAS,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;AAE5C;;;;;GAKG;AACH,SAAgB,IAAI,CAAI,KAAQ;IAC9B,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AACjC,CAAC;AAED;;;;;GAKG;AACH,SAAgB,MAAM,CAAI,MAAiB;IACzC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;AACxB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,MAAM,CAAI,MAAiB;IACzC,OAAO,MAAM,CAAC,MAAM,CAAC;AACvB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,GAAG,CAAO,CAAc;IACtC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,YAAI,CAAC,CAAC;AACrE,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,OAAO,CAAO,CAAsB;IAClD,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,YAAI,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,SAAS,CAAI,YAAe;IAC1C,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;AACpE,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,KAAK,CACnB,MAAe,EACf,MAAuB;IAEvB,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;AACxE,CAAC;AAED;;;;;;GAMG;AACH,wDAAwD;AACxD,SAAgB,YAAY,CAAI,KAA2B;IACzD,OAAO,IAAA,eAAK,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,YAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC3C,CAAC"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { either as E } from "@clipboard-health/util-ts";
|
|
2
|
+
import { type SafeParseReturnType } from "zod";
|
|
2
3
|
import { ServiceError, type ServiceErrorParams } from "../errors/serviceError";
|
|
3
4
|
/**
|
|
4
5
|
* Represents the result of a service operation that may fail.
|
|
@@ -21,3 +22,4 @@ export declare function success<A>(value: A): ServiceResult<A>;
|
|
|
21
22
|
* @returns A `ServiceResult` containing the error
|
|
22
23
|
*/
|
|
23
24
|
export declare function failure<A = never>(params: ServiceErrorParams | ServiceError): ServiceResult<A>;
|
|
25
|
+
export declare function fromSafeParseReturnType<A>(value: SafeParseReturnType<unknown, A>): ServiceResult<A>;
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.success = success;
|
|
4
4
|
exports.failure = failure;
|
|
5
|
+
exports.fromSafeParseReturnType = fromSafeParseReturnType;
|
|
5
6
|
const util_ts_1 = require("@clipboard-health/util-ts");
|
|
6
7
|
const serviceError_1 = require("../errors/serviceError");
|
|
7
8
|
/**
|
|
@@ -24,4 +25,9 @@ function success(value) {
|
|
|
24
25
|
function failure(params) {
|
|
25
26
|
return util_ts_1.either.left(params instanceof serviceError_1.ServiceError ? params : new serviceError_1.ServiceError(params));
|
|
26
27
|
}
|
|
28
|
+
function fromSafeParseReturnType(value) {
|
|
29
|
+
return value.success
|
|
30
|
+
? success(value.data)
|
|
31
|
+
: failure({ issues: value.error.issues.map(serviceError_1.toZodIssue) });
|
|
32
|
+
}
|
|
27
33
|
//# sourceMappingURL=serviceResult.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"serviceResult.js","sourceRoot":"","sources":["../../../../../../packages/util-ts/src/lib/functional/serviceResult.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"serviceResult.js","sourceRoot":"","sources":["../../../../../../packages/util-ts/src/lib/functional/serviceResult.ts"],"names":[],"mappings":";;AAkBA,0BAEC;AASD,0BAEC;AAED,0DAMC;AAvCD,uDAAwD;AAGxD,yDAA2F;AAQ3F;;;;;;GAMG;AACH,SAAgB,OAAO,CAAI,KAAQ;IACjC,OAAO,gBAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AACxB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,OAAO,CAAY,MAAyC;IAC1E,OAAO,gBAAC,CAAC,IAAI,CAAC,MAAM,YAAY,2BAAY,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,2BAAY,CAAC,MAAM,CAAC,CAAC,CAAC;AACpF,CAAC;AAED,SAAgB,uBAAuB,CACrC,KAAsC;IAEtC,OAAO,KAAK,CAAC,OAAO;QAClB,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;QACrB,CAAC,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,yBAAU,CAAC,EAAE,CAAC,CAAC;AAC9D,CAAC"}
|