@servora/proto-utils 0.1.3 → 0.1.5
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/crud/index.d.ts +14 -1
- package/dist/crud/index.d.ts.map +1 -1
- package/dist/crud/index.js +66 -3
- package/dist/crud/index.js.map +1 -1
- package/dist/errors.d.ts +27 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +59 -0
- package/dist/errors.js.map +1 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +4 -23
- package/src/client/.gitkeep +0 -0
- package/src/crud/AGENTS.md +2 -2
- package/src/crud/index.ts +114 -13
- package/src/errors.ts +80 -0
- package/src/gen/servora/example/v1/example.crud.ts +2 -3
- package/src/index.ts +1 -1
- package/dist/client/errors.d.ts +0 -32
- package/dist/client/errors.d.ts.map +0 -1
- package/dist/client/errors.js +0 -37
- package/dist/client/errors.js.map +0 -1
- package/dist/client/index.d.ts +0 -3
- package/dist/client/index.d.ts.map +0 -1
- package/dist/client/index.js +0 -3
- package/dist/client/index.js.map +0 -1
- package/dist/client/request.d.ts +0 -54
- package/dist/client/request.d.ts.map +0 -1
- package/dist/client/request.js +0 -150
- package/dist/client/request.js.map +0 -1
- package/src/client/errors.ts +0 -54
- package/src/client/index.ts +0 -2
- package/src/client/request.ts +0 -234
package/dist/crud/index.d.ts
CHANGED
|
@@ -19,7 +19,20 @@ export type RawFilterValue = Readonly<{
|
|
|
19
19
|
}>;
|
|
20
20
|
/** Use for validated enum symbols or AIP functions such as duration("5s"). */
|
|
21
21
|
export declare function rawFilterValue(text: string): RawFilterValue;
|
|
22
|
-
|
|
22
|
+
declare const stringMatchValueSymbol: unique symbol;
|
|
23
|
+
export type StringMatchValueKind = "prefix" | "suffix" | "contains";
|
|
24
|
+
export type StringMatchValue = Readonly<{
|
|
25
|
+
[stringMatchValueSymbol]: true;
|
|
26
|
+
kind: StringMatchValueKind;
|
|
27
|
+
value: string;
|
|
28
|
+
}>;
|
|
29
|
+
/** Builds a typed string prefix filter value. */
|
|
30
|
+
export declare function filterPrefix(value: string): StringMatchValue;
|
|
31
|
+
/** Builds a typed string suffix filter value. */
|
|
32
|
+
export declare function filterSuffix(value: string): StringMatchValue;
|
|
33
|
+
/** Builds a typed string contains filter value. */
|
|
34
|
+
export declare function filterContains(value: string): StringMatchValue;
|
|
35
|
+
export type FilterValue = string | number | bigint | boolean | Date | null | RawFilterValue | StringMatchValue;
|
|
23
36
|
export type FilterExpression<Field extends string> = Readonly<{
|
|
24
37
|
field: Field;
|
|
25
38
|
operator: FilterOperator;
|
package/dist/crud/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/crud/index.ts"],"names":[],"mappings":"AAAA,qBAAa,iBAAkB,SAAQ,KAAK;IAC1C,SAAkB,IAAI,uBAAuB;gBAEjC,OAAO,EAAE,MAAM;CAG5B;AAED,MAAM,MAAM,eAAe,GACvB,SAAS,MAAM,EAAE,GACjB,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAErC,MAAM,MAAM,OAAO,CAAC,MAAM,SAAS,eAAe,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/crud/index.ts"],"names":[],"mappings":"AAAA,qBAAa,iBAAkB,SAAQ,KAAK;IAC1C,SAAkB,IAAI,uBAAuB;gBAEjC,OAAO,EAAE,MAAM;CAG5B;AAED,MAAM,MAAM,eAAe,GACvB,SAAS,MAAM,EAAE,GACjB,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAErC,MAAM,MAAM,OAAO,CAAC,MAAM,SAAS,eAAe,IAChD,MAAM,SAAS,SAAS,CAAC,MAAM,KAAK,SAAS,MAAM,CAAC,EAAE,GAClD,KAAK,GACL,MAAM,SAAS,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,KAAK,SAAS,MAAM,CAAC,CAAC,GACjE,KAAK,GACL,KAAK,CAAC;AAEd,MAAM,MAAM,UAAU,CAAC,MAAM,SAAS,eAAe,IACnD,MAAM,SAAS,SAAS,CAAC,MAAM,KAAK,SAAS,MAAM,CAAC,EAAE,GAClD,KAAK,GACL,MAAM,SAAS,QAAQ,CAAC,MAAM,CAAC,MAAM,GAAG,SAAS,MAAM,EAAE,MAAM,CAAC,CAAC,GAC/D,GAAG,GACH,KAAK,CAAC;AAkBd;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,KAAK,CAAC,MAAM,SAAS,eAAe,EACpC,MAAM,SAAS,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,EAC3D,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAYxC;AAED,MAAM,MAAM,cAAc,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,CAAC;AAYxE,QAAA,MAAM,oBAAoB,EAAE,OAAO,MAAiC,CAAC;AAErE,MAAM,MAAM,cAAc,GAAG,QAAQ,CAAC;IACpC,CAAC,oBAAoB,CAAC,EAAE,IAAI,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC,CAAC;AAEH,8EAA8E;AAC9E,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,CAK3D;AAED,QAAA,MAAM,sBAAsB,EAAE,OAAO,MAAmC,CAAC;AAEzE,MAAM,MAAM,oBAAoB,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC;AAEpE,MAAM,MAAM,gBAAgB,GAAG,QAAQ,CAAC;IACtC,CAAC,sBAAsB,CAAC,EAAE,IAAI,CAAC;IAC/B,IAAI,EAAE,oBAAoB,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC;CACf,CAAC,CAAC;AAaH,iDAAiD;AACjD,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAE5D;AAED,iDAAiD;AACjD,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAE5D;AAED,mDAAmD;AACnD,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAE9D;AAED,MAAM,MAAM,WAAW,GACnB,MAAM,GACN,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,cAAc,GACd,gBAAgB,CAAC;AAErB,MAAM,MAAM,gBAAgB,CAAC,KAAK,SAAS,MAAM,IAC7C,QAAQ,CAAC;IACP,KAAK,EAAE,KAAK,CAAC;IACb,QAAQ,EAAE,cAAc,CAAC;IACzB,KAAK,EAAE,WAAW,CAAC;CACpB,CAAC,GACF,QAAQ,CAAC;IAAE,GAAG,EAAE,SAAS,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAA;CAAE,CAAC,GACrD,QAAQ,CAAC;IAAE,EAAE,EAAE,SAAS,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAA;CAAE,CAAC,CAAC;AAEzD,mFAAmF;AACnF,wBAAgB,WAAW,CAAC,KAAK,CAAC,MAAM,SAAS,eAAe,EAC9D,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,GACpD,MAAM,GAAG,SAAS,CAGpB;AAkGD,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,MAAM,CAAC;AAE5C,MAAM,MAAM,SAAS,CAAC,KAAK,SAAS,MAAM,IAAI,QAAQ,CAAC;IACrD,KAAK,EAAE,KAAK,CAAC;IACb,SAAS,CAAC,EAAE,cAAc,CAAC;CAC5B,CAAC,CAAC;AAEH,mEAAmE;AACnE,wBAAgB,YAAY,CAAC,KAAK,CAAC,MAAM,SAAS,eAAe,EAC/D,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,SAAS,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,IAAI,GACnD,MAAM,GAAG,SAAS,CAgBpB;AAED,MAAM,MAAM,KAAK,GAAG,QAAQ,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC,CAAC;AAEH,eAAO,MAAM,SAAS,EAAE,KAA2C,CAAC;AAEpE,mFAAmF;AACnF,wBAAgB,YAAY,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,KAAK,CAIjE;AAED,4DAA4D;AAC5D,wBAAgB,UAAU,CAAC,OAAO,SAAS,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAC1E,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,OAAO,GACf,OAAO,GAAG;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,CAQlC"}
|
package/dist/crud/index.js
CHANGED
|
@@ -33,6 +33,15 @@ export function makeUpdateMask(fields, values) {
|
|
|
33
33
|
.map(([, path]) => path)
|
|
34
34
|
.join(",");
|
|
35
35
|
}
|
|
36
|
+
const filterOperators = {
|
|
37
|
+
"=": true,
|
|
38
|
+
"!=": true,
|
|
39
|
+
"<": true,
|
|
40
|
+
"<=": true,
|
|
41
|
+
">": true,
|
|
42
|
+
">=": true,
|
|
43
|
+
":": true,
|
|
44
|
+
};
|
|
36
45
|
const rawFilterValueSymbol = Symbol("RawFilterValue");
|
|
37
46
|
/** Use for validated enum symbols or AIP functions such as duration("5s"). */
|
|
38
47
|
export function rawFilterValue(text) {
|
|
@@ -41,6 +50,26 @@ export function rawFilterValue(text) {
|
|
|
41
50
|
}
|
|
42
51
|
return Object.freeze({ [rawFilterValueSymbol]: true, text });
|
|
43
52
|
}
|
|
53
|
+
const stringMatchValueSymbol = Symbol("StringMatchValue");
|
|
54
|
+
function stringMatchValue(kind, value) {
|
|
55
|
+
return Object.freeze({
|
|
56
|
+
[stringMatchValueSymbol]: true,
|
|
57
|
+
kind,
|
|
58
|
+
value,
|
|
59
|
+
});
|
|
60
|
+
}
|
|
61
|
+
/** Builds a typed string prefix filter value. */
|
|
62
|
+
export function filterPrefix(value) {
|
|
63
|
+
return stringMatchValue("prefix", value);
|
|
64
|
+
}
|
|
65
|
+
/** Builds a typed string suffix filter value. */
|
|
66
|
+
export function filterSuffix(value) {
|
|
67
|
+
return stringMatchValue("suffix", value);
|
|
68
|
+
}
|
|
69
|
+
/** Builds a typed string contains filter value. */
|
|
70
|
+
export function filterContains(value) {
|
|
71
|
+
return stringMatchValue("contains", value);
|
|
72
|
+
}
|
|
44
73
|
/** Serializes a typed expression into the AIP-160 filter text accepted by CRUD. */
|
|
45
74
|
export function buildFilter(fields, expression) {
|
|
46
75
|
if (expression == null)
|
|
@@ -52,9 +81,18 @@ function renderFilter(expression, fields) {
|
|
|
52
81
|
if (!fields.has(expression.field)) {
|
|
53
82
|
throw new RangeError(`unknown filter field: ${expression.field}`);
|
|
54
83
|
}
|
|
55
|
-
if (
|
|
84
|
+
if (!Object.prototype.hasOwnProperty.call(filterOperators, expression.operator)) {
|
|
85
|
+
throw new RangeError(`unsupported filter operator: ${String(expression.operator)}`);
|
|
86
|
+
}
|
|
87
|
+
if (expression.value === null &&
|
|
88
|
+
!["=", "!="].includes(expression.operator)) {
|
|
56
89
|
throw new RangeError("null filter values only support = and !=");
|
|
57
90
|
}
|
|
91
|
+
if (isStringMatchValue(expression.value) &&
|
|
92
|
+
expression.operator !== "=" &&
|
|
93
|
+
expression.operator !== "!=") {
|
|
94
|
+
throw new RangeError("typed wildcard filter values only support = and !=");
|
|
95
|
+
}
|
|
58
96
|
return `${expression.field} ${expression.operator} ${renderFilterValue(expression.value)}`;
|
|
59
97
|
}
|
|
60
98
|
const [operator, children] = "and" in expression
|
|
@@ -68,8 +106,9 @@ function renderFilter(expression, fields) {
|
|
|
68
106
|
function renderFilterValue(value) {
|
|
69
107
|
if (value === null)
|
|
70
108
|
return "null";
|
|
71
|
-
if (typeof value === "string")
|
|
72
|
-
return JSON.stringify(value);
|
|
109
|
+
if (typeof value === "string") {
|
|
110
|
+
return JSON.stringify(escapeWildcardLiteral(value));
|
|
111
|
+
}
|
|
73
112
|
if (typeof value === "boolean" || typeof value === "bigint") {
|
|
74
113
|
return value.toString();
|
|
75
114
|
}
|
|
@@ -85,8 +124,32 @@ function renderFilterValue(value) {
|
|
|
85
124
|
}
|
|
86
125
|
return `timestamp(${JSON.stringify(value.toISOString())})`;
|
|
87
126
|
}
|
|
127
|
+
if (isStringMatchValue(value)) {
|
|
128
|
+
return renderStringMatchValue(value);
|
|
129
|
+
}
|
|
88
130
|
return value.text;
|
|
89
131
|
}
|
|
132
|
+
function isStringMatchValue(value) {
|
|
133
|
+
return (typeof value === "object" &&
|
|
134
|
+
value !== null &&
|
|
135
|
+
stringMatchValueSymbol in value);
|
|
136
|
+
}
|
|
137
|
+
function escapeWildcardLiteral(value) {
|
|
138
|
+
return value.replaceAll("\\", "\\\\").replaceAll("*", "\\*");
|
|
139
|
+
}
|
|
140
|
+
function renderStringMatchValue(value) {
|
|
141
|
+
if (value.value.length === 0)
|
|
142
|
+
return JSON.stringify("*");
|
|
143
|
+
const literal = escapeWildcardLiteral(value.value);
|
|
144
|
+
switch (value.kind) {
|
|
145
|
+
case "prefix":
|
|
146
|
+
return JSON.stringify(`${literal}*`);
|
|
147
|
+
case "suffix":
|
|
148
|
+
return JSON.stringify(`*${literal}`);
|
|
149
|
+
case "contains":
|
|
150
|
+
return JSON.stringify(`*${literal}*`);
|
|
151
|
+
}
|
|
152
|
+
}
|
|
90
153
|
/** Serializes typed terms into canonical AIP-132 order_by text. */
|
|
91
154
|
export function buildOrderBy(fields, terms) {
|
|
92
155
|
if (terms == null || terms.length === 0)
|
package/dist/crud/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/crud/index.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,iBAAkB,SAAQ,KAAK;IACxB,IAAI,GAAG,mBAAmB,CAAC;IAE7C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;CACF;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/crud/index.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,iBAAkB,SAAQ,KAAK;IACxB,IAAI,GAAG,mBAAmB,CAAC;IAE7C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;CACF;AAoBD,SAAS,YAAY,CACnB,MAAuB;IAEvB,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QAC1B,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,CAAU,CAAC;QAChD,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,MAA0C,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,WAAW,CAAC,MAAuB;IAC1C,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;AACtD,CAAC;AAED,SAAS,aAAa,CAAC,MAAuB;IAC5C,OAAO,IAAI,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;AACtC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAG5B,MAAc,EAAE,MAAc;IAC9B,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACzD,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9C,MAAM,OAAO,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IACzE,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,UAAU,CAAC,yBAAyB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,OAAO;SACX,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SACpC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC;SACvB,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAID,MAAM,eAAe,GAAiC;IACpD,GAAG,EAAE,IAAI;IACT,IAAI,EAAE,IAAI;IACV,GAAG,EAAE,IAAI;IACT,IAAI,EAAE,IAAI;IACV,GAAG,EAAE,IAAI;IACT,IAAI,EAAE,IAAI;IACV,GAAG,EAAE,IAAI;CACV,CAAC;AAEF,MAAM,oBAAoB,GAAkB,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAOrE,8EAA8E;AAC9E,MAAM,UAAU,cAAc,CAAC,IAAY;IACzC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,UAAU,CAAC,oCAAoC,CAAC,CAAC;IAC7D,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,oBAAoB,CAAC,EAAE,IAAa,EAAE,IAAI,EAAE,CAAC,CAAC;AACxE,CAAC;AAED,MAAM,sBAAsB,GAAkB,MAAM,CAAC,kBAAkB,CAAC,CAAC;AAUzE,SAAS,gBAAgB,CACvB,IAA0B,EAC1B,KAAa;IAEb,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,CAAC,sBAAsB,CAAC,EAAE,IAAa;QACvC,IAAI;QACJ,KAAK;KACN,CAAC,CAAC;AACL,CAAC;AAED,iDAAiD;AACjD,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,OAAO,gBAAgB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;AAC3C,CAAC;AAED,iDAAiD;AACjD,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,OAAO,gBAAgB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;AAC3C,CAAC;AAED,mDAAmD;AACnD,MAAM,UAAU,cAAc,CAAC,KAAa;IAC1C,OAAO,gBAAgB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;AAC7C,CAAC;AAqBD,mFAAmF;AACnF,MAAM,UAAU,WAAW,CACzB,MAAc,EACd,UAAqD;IAErD,IAAI,UAAU,IAAI,IAAI;QAAE,OAAO,SAAS,CAAC;IACzC,OAAO,YAAY,CAAC,UAAU,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;AACzD,CAAC;AAED,SAAS,YAAY,CACnB,UAAoC,EACpC,MAA2B;IAE3B,IAAI,OAAO,IAAI,UAAU,EAAE,CAAC;QAC1B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,UAAU,CAAC,yBAAyB,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC;QACpE,CAAC;QACD,IACE,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CACnC,eAAe,EACf,UAAU,CAAC,QAAQ,CACpB,EACD,CAAC;YACD,MAAM,IAAI,UAAU,CAClB,gCAAgC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAC9D,CAAC;QACJ,CAAC;QACD,IACE,UAAU,CAAC,KAAK,KAAK,IAAI;YACzB,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,EAC1C,CAAC;YACD,MAAM,IAAI,UAAU,CAAC,0CAA0C,CAAC,CAAC;QACnE,CAAC;QACD,IACE,kBAAkB,CAAC,UAAU,CAAC,KAAK,CAAC;YACpC,UAAU,CAAC,QAAQ,KAAK,GAAG;YAC3B,UAAU,CAAC,QAAQ,KAAK,IAAI,EAC5B,CAAC;YACD,MAAM,IAAI,UAAU,CAClB,oDAAoD,CACrD,CAAC;QACJ,CAAC;QACD,OAAO,GAAG,UAAU,CAAC,KAAK,IAAI,UAAU,CAAC,QAAQ,IAAI,iBAAiB,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;IAC7F,CAAC;IACD,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,GACxB,KAAK,IAAI,UAAU;QACjB,CAAC,CAAE,CAAC,KAAK,EAAE,UAAU,CAAC,GAAG,CAAW;QACpC,CAAC,CAAE,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,CAAW,CAAC;IACvC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,UAAU,CAAC,GAAG,QAAQ,iCAAiC,CAAC,CAAC;IACrE,CAAC;IACD,OAAO,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,QAAQ,GAAG,CAAC,GAAG,CAAC;AAC3F,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAkB;IAC3C,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,MAAM,CAAC;IAClC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC;IACtD,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5D,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC1B,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,UAAU,CAAC,+BAA+B,CAAC,CAAC;QACxD,CAAC;QACD,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC1B,CAAC;IACD,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;QAC1B,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,UAAU,CAAC,2BAA2B,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,aAAa,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC;IAC7D,CAAC;IACD,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,sBAAsB,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC;AACpB,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAkB;IAC5C,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,sBAAsB,IAAI,KAAK,CAChC,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAa;IAC1C,OAAO,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,sBAAsB,CAAC,KAAuB;IACrD,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACzD,MAAM,OAAO,GAAG,qBAAqB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACnD,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,QAAQ;YACX,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,GAAG,CAAC,CAAC;QACvC,KAAK,QAAQ;YACX,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,OAAO,EAAE,CAAC,CAAC;QACvC,KAAK,UAAU;YACb,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,OAAO,GAAG,CAAC,CAAC;IAC1C,CAAC;AACH,CAAC;AASD,mEAAmE;AACnE,MAAM,UAAU,YAAY,CAC1B,MAAc,EACd,KAAoD;IAEpD,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAC1D,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,OAAO,KAAK;SACT,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,GAAG,KAAK,EAAE,EAAE,EAAE;QACpC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,UAAU,CAAC,wBAAwB,KAAK,EAAE,CAAC,CAAC;QACxD,CAAC;QACD,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACpB,MAAM,IAAI,UAAU,CAAC,0BAA0B,KAAK,EAAE,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAChB,OAAO,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;IACxD,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAOD,MAAM,CAAC,MAAM,SAAS,GAAU,MAAM,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;AAEpE,mFAAmF;AACnF,MAAM,UAAU,YAAY,CAAC,aAA6B;IACxD,OAAO,aAAa;QAClB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;QAC/D,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;AACzC,CAAC;AAED,4DAA4D;AAC5D,MAAM,UAAU,UAAU,CACxB,KAAY,EACZ,OAAgB;IAEhB,MAAM,IAAI,GAAG,EAAE,GAAG,OAAO,EAAsC,CAAC;IAChE,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;SAAM,CAAC;QACN,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;IACnC,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}
|
package/dist/errors.d.ts
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
export type ApiErrorKind = "http" | "network" | "timeout";
|
|
2
|
+
export declare class ApiError extends Error {
|
|
3
|
+
readonly kind: ApiErrorKind;
|
|
4
|
+
readonly httpStatus?: number;
|
|
5
|
+
readonly responseBody?: unknown;
|
|
6
|
+
readonly service: string;
|
|
7
|
+
readonly method: string;
|
|
8
|
+
constructor(options: {
|
|
9
|
+
kind: ApiErrorKind;
|
|
10
|
+
message: string;
|
|
11
|
+
httpStatus?: number;
|
|
12
|
+
responseBody?: unknown;
|
|
13
|
+
service: string;
|
|
14
|
+
method: string;
|
|
15
|
+
cause?: unknown;
|
|
16
|
+
});
|
|
17
|
+
}
|
|
18
|
+
export interface KratosErrorBody {
|
|
19
|
+
code: number;
|
|
20
|
+
reason: string;
|
|
21
|
+
message: string;
|
|
22
|
+
metadata?: Record<string, string>;
|
|
23
|
+
}
|
|
24
|
+
export declare function parseKratosErrorBody(value: unknown): KratosErrorBody | null;
|
|
25
|
+
export declare function parseKratosError(error: ApiError): KratosErrorBody | null;
|
|
26
|
+
export declare function isKratosReason(error: ApiError, reason: string): boolean;
|
|
27
|
+
//# sourceMappingURL=errors.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;AAE1D,qBAAa,QAAS,SAAQ,KAAK;IACjC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAChC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAEZ,OAAO,EAAE;QACnB,IAAI,EAAE,YAAY,CAAC;QACnB,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB;CASF;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAoBD,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,eAAe,GAAG,IAAI,CAiB3E;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,QAAQ,GAAG,eAAe,GAAG,IAAI,CAGxE;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAEvE"}
|
package/dist/errors.js
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
export class ApiError extends Error {
|
|
2
|
+
kind;
|
|
3
|
+
httpStatus;
|
|
4
|
+
responseBody;
|
|
5
|
+
service;
|
|
6
|
+
method;
|
|
7
|
+
constructor(options) {
|
|
8
|
+
super(options.message, { cause: options.cause });
|
|
9
|
+
this.name = "ApiError";
|
|
10
|
+
this.kind = options.kind;
|
|
11
|
+
this.httpStatus = options.httpStatus;
|
|
12
|
+
this.responseBody = options.responseBody;
|
|
13
|
+
this.service = options.service;
|
|
14
|
+
this.method = options.method;
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
function isRecord(value) {
|
|
18
|
+
return typeof value === "object" && value !== null && !Array.isArray(value);
|
|
19
|
+
}
|
|
20
|
+
function isStringRecord(value) {
|
|
21
|
+
if (!isRecord(value))
|
|
22
|
+
return false;
|
|
23
|
+
for (const key in value) {
|
|
24
|
+
if (Object.prototype.hasOwnProperty.call(value, key) &&
|
|
25
|
+
typeof value[key] !== "string") {
|
|
26
|
+
return false;
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
return true;
|
|
30
|
+
}
|
|
31
|
+
export function parseKratosErrorBody(value) {
|
|
32
|
+
try {
|
|
33
|
+
if (!isRecord(value))
|
|
34
|
+
return null;
|
|
35
|
+
if (!Number.isInteger(value.code))
|
|
36
|
+
return null;
|
|
37
|
+
if (typeof value.reason !== "string")
|
|
38
|
+
return null;
|
|
39
|
+
if (typeof value.message !== "string")
|
|
40
|
+
return null;
|
|
41
|
+
if (Object.prototype.hasOwnProperty.call(value, "metadata") &&
|
|
42
|
+
!isStringRecord(value.metadata)) {
|
|
43
|
+
return null;
|
|
44
|
+
}
|
|
45
|
+
return value;
|
|
46
|
+
}
|
|
47
|
+
catch {
|
|
48
|
+
return null;
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
export function parseKratosError(error) {
|
|
52
|
+
if (error.kind !== "http")
|
|
53
|
+
return null;
|
|
54
|
+
return parseKratosErrorBody(error.responseBody);
|
|
55
|
+
}
|
|
56
|
+
export function isKratosReason(error, reason) {
|
|
57
|
+
return parseKratosError(error)?.reason === reason;
|
|
58
|
+
}
|
|
59
|
+
//# sourceMappingURL=errors.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,QAAS,SAAQ,KAAK;IACxB,IAAI,CAAe;IACnB,UAAU,CAAU;IACpB,YAAY,CAAW;IACvB,OAAO,CAAS;IAChB,MAAM,CAAS;IAExB,YAAY,OAQX;QACC,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QACjD,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAC/B,CAAC;CACF;AASD,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,cAAc,CAAC,KAAc;IACpC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAEnC,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;QACxB,IACE,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC;YAChD,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,QAAQ,EAC9B,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,KAAc;IACjD,IAAI,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAClC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAC;QAC/C,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC;QAClD,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC;QACnD,IACE,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC;YACvD,CAAC,cAAc,CAAC,KAAK,CAAC,QAAQ,CAAC,EAC/B,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,KAAmC,CAAC;IAC7C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,KAAe;IAC9C,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM;QAAE,OAAO,IAAI,CAAC;IACvC,OAAO,oBAAoB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAe,EAAE,MAAc;IAC5D,OAAO,gBAAgB,CAAC,KAAK,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;AACpD,CAAC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export
|
|
1
|
+
export {};
|
|
2
2
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export
|
|
1
|
+
export {};
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@servora/proto-utils",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "Servora Proto 工具:CRUD 查询、FieldMask、
|
|
3
|
+
"version": "0.1.5",
|
|
4
|
+
"description": "Servora Proto 工具:CRUD 查询、FieldMask、ProtoJSON 与 Kratos 错误解析",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"exports": {
|
|
7
7
|
".": {
|
|
@@ -12,29 +12,13 @@
|
|
|
12
12
|
"types": "./dist/crud/index.d.ts",
|
|
13
13
|
"import": "./dist/crud/index.js"
|
|
14
14
|
},
|
|
15
|
-
"./client": {
|
|
16
|
-
"types": "./dist/client/index.d.ts",
|
|
17
|
-
"import": "./dist/client/index.js"
|
|
18
|
-
},
|
|
19
|
-
"./client/request": {
|
|
20
|
-
"types": "./dist/client/request.d.ts",
|
|
21
|
-
"import": "./dist/client/request.js"
|
|
22
|
-
},
|
|
23
|
-
"./client/errors": {
|
|
24
|
-
"types": "./dist/client/errors.d.ts",
|
|
25
|
-
"import": "./dist/client/errors.js"
|
|
26
|
-
},
|
|
27
15
|
"./proto/*": {
|
|
28
16
|
"types": "./dist/gen/*/index.d.ts",
|
|
29
17
|
"import": "./dist/gen/*/index.js"
|
|
30
18
|
},
|
|
31
|
-
"./request": {
|
|
32
|
-
"types": "./dist/client/request.d.ts",
|
|
33
|
-
"import": "./dist/client/request.js"
|
|
34
|
-
},
|
|
35
19
|
"./errors": {
|
|
36
|
-
"types": "./dist/
|
|
37
|
-
"import": "./dist/
|
|
20
|
+
"types": "./dist/errors.d.ts",
|
|
21
|
+
"import": "./dist/errors.js"
|
|
38
22
|
}
|
|
39
23
|
},
|
|
40
24
|
"files": [
|
|
@@ -60,9 +44,6 @@
|
|
|
60
44
|
},
|
|
61
45
|
"license": "MIT",
|
|
62
46
|
"sideEffects": false,
|
|
63
|
-
"dependencies": {
|
|
64
|
-
"ofetch": "^1.5.1"
|
|
65
|
-
},
|
|
66
47
|
"devDependencies": {
|
|
67
48
|
"typescript": "^5.7.2"
|
|
68
49
|
}
|
|
File without changes
|
package/src/crud/AGENTS.md
CHANGED
package/src/crud/index.ts
CHANGED
|
@@ -10,13 +10,12 @@ export type FieldCollection =
|
|
|
10
10
|
| readonly string[]
|
|
11
11
|
| Readonly<Record<string, string>>;
|
|
12
12
|
|
|
13
|
-
export type FieldOf<Fields extends FieldCollection> =
|
|
14
|
-
infer Field extends string
|
|
15
|
-
)[]
|
|
16
|
-
? Field
|
|
17
|
-
: Fields extends Readonly<Record<string, infer Field extends string>>
|
|
13
|
+
export type FieldOf<Fields extends FieldCollection> =
|
|
14
|
+
Fields extends readonly (infer Field extends string)[]
|
|
18
15
|
? Field
|
|
19
|
-
:
|
|
16
|
+
: Fields extends Readonly<Record<string, infer Field extends string>>
|
|
17
|
+
? Field
|
|
18
|
+
: never;
|
|
20
19
|
|
|
21
20
|
export type FieldKeyOf<Fields extends FieldCollection> =
|
|
22
21
|
Fields extends readonly (infer Field extends string)[]
|
|
@@ -25,7 +24,9 @@ export type FieldKeyOf<Fields extends FieldCollection> =
|
|
|
25
24
|
? Key
|
|
26
25
|
: never;
|
|
27
26
|
|
|
28
|
-
function fieldEntries(
|
|
27
|
+
function fieldEntries(
|
|
28
|
+
fields: FieldCollection,
|
|
29
|
+
): ReadonlyArray<readonly [string, string]> {
|
|
29
30
|
return Array.isArray(fields)
|
|
30
31
|
? fields.map((field) => [field, field] as const)
|
|
31
32
|
: Object.entries(fields as Readonly<Record<string, string>>);
|
|
@@ -63,6 +64,16 @@ export function makeUpdateMask<
|
|
|
63
64
|
|
|
64
65
|
export type FilterOperator = "=" | "!=" | "<" | "<=" | ">" | ">=" | ":";
|
|
65
66
|
|
|
67
|
+
const filterOperators: Record<FilterOperator, true> = {
|
|
68
|
+
"=": true,
|
|
69
|
+
"!=": true,
|
|
70
|
+
"<": true,
|
|
71
|
+
"<=": true,
|
|
72
|
+
">": true,
|
|
73
|
+
">=": true,
|
|
74
|
+
":": true,
|
|
75
|
+
};
|
|
76
|
+
|
|
66
77
|
const rawFilterValueSymbol: unique symbol = Symbol("RawFilterValue");
|
|
67
78
|
|
|
68
79
|
export type RawFilterValue = Readonly<{
|
|
@@ -78,6 +89,42 @@ export function rawFilterValue(text: string): RawFilterValue {
|
|
|
78
89
|
return Object.freeze({ [rawFilterValueSymbol]: true as const, text });
|
|
79
90
|
}
|
|
80
91
|
|
|
92
|
+
const stringMatchValueSymbol: unique symbol = Symbol("StringMatchValue");
|
|
93
|
+
|
|
94
|
+
export type StringMatchValueKind = "prefix" | "suffix" | "contains";
|
|
95
|
+
|
|
96
|
+
export type StringMatchValue = Readonly<{
|
|
97
|
+
[stringMatchValueSymbol]: true;
|
|
98
|
+
kind: StringMatchValueKind;
|
|
99
|
+
value: string;
|
|
100
|
+
}>;
|
|
101
|
+
|
|
102
|
+
function stringMatchValue(
|
|
103
|
+
kind: StringMatchValueKind,
|
|
104
|
+
value: string,
|
|
105
|
+
): StringMatchValue {
|
|
106
|
+
return Object.freeze({
|
|
107
|
+
[stringMatchValueSymbol]: true as const,
|
|
108
|
+
kind,
|
|
109
|
+
value,
|
|
110
|
+
});
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
/** Builds a typed string prefix filter value. */
|
|
114
|
+
export function filterPrefix(value: string): StringMatchValue {
|
|
115
|
+
return stringMatchValue("prefix", value);
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
/** Builds a typed string suffix filter value. */
|
|
119
|
+
export function filterSuffix(value: string): StringMatchValue {
|
|
120
|
+
return stringMatchValue("suffix", value);
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
/** Builds a typed string contains filter value. */
|
|
124
|
+
export function filterContains(value: string): StringMatchValue {
|
|
125
|
+
return stringMatchValue("contains", value);
|
|
126
|
+
}
|
|
127
|
+
|
|
81
128
|
export type FilterValue =
|
|
82
129
|
| string
|
|
83
130
|
| number
|
|
@@ -85,7 +132,8 @@ export type FilterValue =
|
|
|
85
132
|
| boolean
|
|
86
133
|
| Date
|
|
87
134
|
| null
|
|
88
|
-
| RawFilterValue
|
|
135
|
+
| RawFilterValue
|
|
136
|
+
| StringMatchValue;
|
|
89
137
|
|
|
90
138
|
export type FilterExpression<Field extends string> =
|
|
91
139
|
| Readonly<{
|
|
@@ -113,14 +161,37 @@ function renderFilter(
|
|
|
113
161
|
if (!fields.has(expression.field)) {
|
|
114
162
|
throw new RangeError(`unknown filter field: ${expression.field}`);
|
|
115
163
|
}
|
|
116
|
-
if (
|
|
164
|
+
if (
|
|
165
|
+
!Object.prototype.hasOwnProperty.call(
|
|
166
|
+
filterOperators,
|
|
167
|
+
expression.operator,
|
|
168
|
+
)
|
|
169
|
+
) {
|
|
170
|
+
throw new RangeError(
|
|
171
|
+
`unsupported filter operator: ${String(expression.operator)}`,
|
|
172
|
+
);
|
|
173
|
+
}
|
|
174
|
+
if (
|
|
175
|
+
expression.value === null &&
|
|
176
|
+
!["=", "!="].includes(expression.operator)
|
|
177
|
+
) {
|
|
117
178
|
throw new RangeError("null filter values only support = and !=");
|
|
118
179
|
}
|
|
180
|
+
if (
|
|
181
|
+
isStringMatchValue(expression.value) &&
|
|
182
|
+
expression.operator !== "=" &&
|
|
183
|
+
expression.operator !== "!="
|
|
184
|
+
) {
|
|
185
|
+
throw new RangeError(
|
|
186
|
+
"typed wildcard filter values only support = and !=",
|
|
187
|
+
);
|
|
188
|
+
}
|
|
119
189
|
return `${expression.field} ${expression.operator} ${renderFilterValue(expression.value)}`;
|
|
120
190
|
}
|
|
121
|
-
const [operator, children] =
|
|
122
|
-
|
|
123
|
-
|
|
191
|
+
const [operator, children] =
|
|
192
|
+
"and" in expression
|
|
193
|
+
? (["AND", expression.and] as const)
|
|
194
|
+
: (["OR", expression.or] as const);
|
|
124
195
|
if (children.length === 0) {
|
|
125
196
|
throw new RangeError(`${operator} filter group must not be empty`);
|
|
126
197
|
}
|
|
@@ -129,7 +200,9 @@ function renderFilter(
|
|
|
129
200
|
|
|
130
201
|
function renderFilterValue(value: FilterValue): string {
|
|
131
202
|
if (value === null) return "null";
|
|
132
|
-
if (typeof value === "string")
|
|
203
|
+
if (typeof value === "string") {
|
|
204
|
+
return JSON.stringify(escapeWildcardLiteral(value));
|
|
205
|
+
}
|
|
133
206
|
if (typeof value === "boolean" || typeof value === "bigint") {
|
|
134
207
|
return value.toString();
|
|
135
208
|
}
|
|
@@ -145,9 +218,37 @@ function renderFilterValue(value: FilterValue): string {
|
|
|
145
218
|
}
|
|
146
219
|
return `timestamp(${JSON.stringify(value.toISOString())})`;
|
|
147
220
|
}
|
|
221
|
+
if (isStringMatchValue(value)) {
|
|
222
|
+
return renderStringMatchValue(value);
|
|
223
|
+
}
|
|
148
224
|
return value.text;
|
|
149
225
|
}
|
|
150
226
|
|
|
227
|
+
function isStringMatchValue(value: FilterValue): value is StringMatchValue {
|
|
228
|
+
return (
|
|
229
|
+
typeof value === "object" &&
|
|
230
|
+
value !== null &&
|
|
231
|
+
stringMatchValueSymbol in value
|
|
232
|
+
);
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
function escapeWildcardLiteral(value: string): string {
|
|
236
|
+
return value.replaceAll("\\", "\\\\").replaceAll("*", "\\*");
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
function renderStringMatchValue(value: StringMatchValue): string {
|
|
240
|
+
if (value.value.length === 0) return JSON.stringify("*");
|
|
241
|
+
const literal = escapeWildcardLiteral(value.value);
|
|
242
|
+
switch (value.kind) {
|
|
243
|
+
case "prefix":
|
|
244
|
+
return JSON.stringify(`${literal}*`);
|
|
245
|
+
case "suffix":
|
|
246
|
+
return JSON.stringify(`*${literal}`);
|
|
247
|
+
case "contains":
|
|
248
|
+
return JSON.stringify(`*${literal}*`);
|
|
249
|
+
}
|
|
250
|
+
}
|
|
251
|
+
|
|
151
252
|
export type OrderDirection = "asc" | "desc";
|
|
152
253
|
|
|
153
254
|
export type OrderTerm<Field extends string> = Readonly<{
|
package/src/errors.ts
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
export type ApiErrorKind = "http" | "network" | "timeout";
|
|
2
|
+
|
|
3
|
+
export class ApiError extends Error {
|
|
4
|
+
readonly kind: ApiErrorKind;
|
|
5
|
+
readonly httpStatus?: number;
|
|
6
|
+
readonly responseBody?: unknown;
|
|
7
|
+
readonly service: string;
|
|
8
|
+
readonly method: string;
|
|
9
|
+
|
|
10
|
+
constructor(options: {
|
|
11
|
+
kind: ApiErrorKind;
|
|
12
|
+
message: string;
|
|
13
|
+
httpStatus?: number;
|
|
14
|
+
responseBody?: unknown;
|
|
15
|
+
service: string;
|
|
16
|
+
method: string;
|
|
17
|
+
cause?: unknown;
|
|
18
|
+
}) {
|
|
19
|
+
super(options.message, { cause: options.cause });
|
|
20
|
+
this.name = "ApiError";
|
|
21
|
+
this.kind = options.kind;
|
|
22
|
+
this.httpStatus = options.httpStatus;
|
|
23
|
+
this.responseBody = options.responseBody;
|
|
24
|
+
this.service = options.service;
|
|
25
|
+
this.method = options.method;
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
export interface KratosErrorBody {
|
|
30
|
+
code: number;
|
|
31
|
+
reason: string;
|
|
32
|
+
message: string;
|
|
33
|
+
metadata?: Record<string, string>;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
function isRecord(value: unknown): value is Record<string, unknown> {
|
|
37
|
+
return typeof value === "object" && value !== null && !Array.isArray(value);
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
function isStringRecord(value: unknown): value is Record<string, string> {
|
|
41
|
+
if (!isRecord(value)) return false;
|
|
42
|
+
|
|
43
|
+
for (const key in value) {
|
|
44
|
+
if (
|
|
45
|
+
Object.prototype.hasOwnProperty.call(value, key) &&
|
|
46
|
+
typeof value[key] !== "string"
|
|
47
|
+
) {
|
|
48
|
+
return false;
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
return true;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
export function parseKratosErrorBody(value: unknown): KratosErrorBody | null {
|
|
55
|
+
try {
|
|
56
|
+
if (!isRecord(value)) return null;
|
|
57
|
+
if (!Number.isInteger(value.code)) return null;
|
|
58
|
+
if (typeof value.reason !== "string") return null;
|
|
59
|
+
if (typeof value.message !== "string") return null;
|
|
60
|
+
if (
|
|
61
|
+
Object.prototype.hasOwnProperty.call(value, "metadata") &&
|
|
62
|
+
!isStringRecord(value.metadata)
|
|
63
|
+
) {
|
|
64
|
+
return null;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
return value as unknown as KratosErrorBody;
|
|
68
|
+
} catch {
|
|
69
|
+
return null;
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function parseKratosError(error: ApiError): KratosErrorBody | null {
|
|
74
|
+
if (error.kind !== "http") return null;
|
|
75
|
+
return parseKratosErrorBody(error.responseBody);
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
export function isKratosReason(error: ApiError, reason: string): boolean {
|
|
79
|
+
return parseKratosError(error)?.reason === reason;
|
|
80
|
+
}
|
|
@@ -23,8 +23,8 @@ export const UserName = {
|
|
|
23
23
|
parse(value: string): UserNameParts {
|
|
24
24
|
const segments = value.split("/");
|
|
25
25
|
if (segments.length === 4 && segments[0] === "tenants" && segments[2] === "users") {
|
|
26
|
-
assertResourceSegment("User", "tenant", segments[1]!);
|
|
27
|
-
assertResourceSegment("User", "user", segments[3]!);
|
|
26
|
+
assertResourceSegment("User", "tenant", segments[1]!);
|
|
27
|
+
assertResourceSegment("User", "user", segments[3]!);
|
|
28
28
|
return {
|
|
29
29
|
tenant: segments[1]!,
|
|
30
30
|
user: segments[3]!,
|
|
@@ -61,4 +61,3 @@ export const UserUpdateFields = {
|
|
|
61
61
|
nickname: "nickname",
|
|
62
62
|
temporaryPassword: "temporary_password",
|
|
63
63
|
} as const;
|
|
64
|
-
|
package/src/index.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export
|
|
1
|
+
export {};
|
package/dist/client/errors.d.ts
DELETED
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Kratos 错误解析工具
|
|
3
|
-
*
|
|
4
|
-
* Kratos 统一错误格式:{ code, reason, message, metadata? }
|
|
5
|
-
* 所有使用 protoc-gen-go-errors 生成的服务均输出此格式。
|
|
6
|
-
*/
|
|
7
|
-
import type { ApiError } from "./request.js";
|
|
8
|
-
export interface KratosErrorBody {
|
|
9
|
-
code: number;
|
|
10
|
-
reason: string;
|
|
11
|
-
message: string;
|
|
12
|
-
metadata?: Record<string, string>;
|
|
13
|
-
}
|
|
14
|
-
/**
|
|
15
|
-
* 从 ApiError 中提取 Kratos 结构化错误体。
|
|
16
|
-
* 非 HTTP 错误、或响应体不符合格式时返回 null。
|
|
17
|
-
*/
|
|
18
|
-
export declare function parseKratosError(err: ApiError): KratosErrorBody | null;
|
|
19
|
-
/**
|
|
20
|
-
* 判断 ApiError 是否为指定的 Kratos reason。
|
|
21
|
-
*
|
|
22
|
-
* @example
|
|
23
|
-
* if (isKratosReason(err, 'EMAIL_NOT_VERIFIED')) { ... }
|
|
24
|
-
*/
|
|
25
|
-
export declare function isKratosReason(err: ApiError, reason: string): boolean;
|
|
26
|
-
/**
|
|
27
|
-
* 提取用户可读的错误消息,含 network / timeout 降级处理。
|
|
28
|
-
*
|
|
29
|
-
* @param fallback 当无法提取有效消息时的兜底文案,默认 '操作失败'
|
|
30
|
-
*/
|
|
31
|
-
export declare function kratosMessage(err: ApiError, fallback?: string): string;
|
|
32
|
-
//# sourceMappingURL=errors.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/client/errors.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE7C,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,QAAQ,GAAG,eAAe,GAAG,IAAI,CAUtE;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAErE;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,QAAQ,EAAE,QAAQ,SAAS,GAAG,MAAM,CAOtE"}
|
package/dist/client/errors.js
DELETED
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* 从 ApiError 中提取 Kratos 结构化错误体。
|
|
3
|
-
* 非 HTTP 错误、或响应体不符合格式时返回 null。
|
|
4
|
-
*/
|
|
5
|
-
export function parseKratosError(err) {
|
|
6
|
-
if (err.kind !== "http" || !err.responseBody)
|
|
7
|
-
return null;
|
|
8
|
-
const body = err.responseBody;
|
|
9
|
-
if (typeof body.code !== "number" ||
|
|
10
|
-
typeof body.reason !== "string" ||
|
|
11
|
-
typeof body.message !== "string")
|
|
12
|
-
return null;
|
|
13
|
-
return body;
|
|
14
|
-
}
|
|
15
|
-
/**
|
|
16
|
-
* 判断 ApiError 是否为指定的 Kratos reason。
|
|
17
|
-
*
|
|
18
|
-
* @example
|
|
19
|
-
* if (isKratosReason(err, 'EMAIL_NOT_VERIFIED')) { ... }
|
|
20
|
-
*/
|
|
21
|
-
export function isKratosReason(err, reason) {
|
|
22
|
-
return parseKratosError(err)?.reason === reason;
|
|
23
|
-
}
|
|
24
|
-
/**
|
|
25
|
-
* 提取用户可读的错误消息,含 network / timeout 降级处理。
|
|
26
|
-
*
|
|
27
|
-
* @param fallback 当无法提取有效消息时的兜底文案,默认 '操作失败'
|
|
28
|
-
*/
|
|
29
|
-
export function kratosMessage(err, fallback = "操作失败") {
|
|
30
|
-
if (err.kind === "network")
|
|
31
|
-
return "网络连接失败,请检查网络设置";
|
|
32
|
-
if (err.kind === "timeout")
|
|
33
|
-
return "请求超时,请稍后重试";
|
|
34
|
-
return (parseKratosError(err)?.message ??
|
|
35
|
-
(err.httpStatus ? `请求失败(HTTP ${err.httpStatus})` : fallback));
|
|
36
|
-
}
|
|
37
|
-
//# sourceMappingURL=errors.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/client/errors.ts"],"names":[],"mappings":"AAeA;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAa;IAC5C,IAAI,GAAG,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,GAAG,CAAC,YAAY;QAAE,OAAO,IAAI,CAAC;IAC1D,MAAM,IAAI,GAAG,GAAG,CAAC,YAAuC,CAAC;IACzD,IACE,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ;QAC7B,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ;QAC/B,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ;QAEhC,OAAO,IAAI,CAAC;IACd,OAAO,IAAkC,CAAC;AAC5C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,GAAa,EAAE,MAAc;IAC1D,OAAO,gBAAgB,CAAC,GAAG,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;AAClD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,GAAa,EAAE,QAAQ,GAAG,MAAM;IAC5D,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS;QAAE,OAAO,gBAAgB,CAAC;IACpD,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS;QAAE,OAAO,YAAY,CAAC;IAChD,OAAO,CACL,gBAAgB,CAAC,GAAG,CAAC,EAAE,OAAO;QAC9B,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,GAAG,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAC7D,CAAC;AACJ,CAAC"}
|
package/dist/client/index.d.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC"}
|
package/dist/client/index.js
DELETED
package/dist/client/index.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC"}
|
package/dist/client/request.d.ts
DELETED
|
@@ -1,54 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @servora/proto-utils/client — 通用 HTTP 请求处理器
|
|
3
|
-
*
|
|
4
|
-
* 为 proto 生成的 TypeScript client 提供标准 RequestHandler 实现,包含:
|
|
5
|
-
* - Bearer token 自动注入
|
|
6
|
-
* - Token 自动刷新(单例防重复)
|
|
7
|
-
* - 结构化 ApiError(区分 http / network / timeout)
|
|
8
|
-
* - 全局 onError 回调(延迟到宏任务,避免与 toast.promise 竞态)
|
|
9
|
-
*
|
|
10
|
-
* 消费方通过 @servora/proto-utils 使用本实现,ofetch 由本包依赖提供。
|
|
11
|
-
*/
|
|
12
|
-
export type RequestType = {
|
|
13
|
-
path: string;
|
|
14
|
-
method: string;
|
|
15
|
-
body: string | null;
|
|
16
|
-
};
|
|
17
|
-
export type RequestMeta = {
|
|
18
|
-
service: string;
|
|
19
|
-
method: string;
|
|
20
|
-
};
|
|
21
|
-
export type RequestHandler = <T = unknown>(request: RequestType, meta: RequestMeta) => Promise<T>;
|
|
22
|
-
export interface TokenStore {
|
|
23
|
-
getAccessToken: () => string | null;
|
|
24
|
-
getRefreshToken: () => string | null;
|
|
25
|
-
setTokens: (accessToken: string, refreshToken: string) => void;
|
|
26
|
-
clear: () => void;
|
|
27
|
-
}
|
|
28
|
-
export interface RequestHandlerOptions {
|
|
29
|
-
baseUrl?: string;
|
|
30
|
-
tokenStore?: TokenStore;
|
|
31
|
-
contextHeaders?: (meta: RequestMeta) => Record<string, string>;
|
|
32
|
-
timeoutMs?: number;
|
|
33
|
-
onError?: (error: ApiError, meta: RequestMeta) => void;
|
|
34
|
-
autoRefreshToken?: boolean;
|
|
35
|
-
}
|
|
36
|
-
export type ApiErrorKind = "http" | "network" | "timeout";
|
|
37
|
-
export declare class ApiError extends Error {
|
|
38
|
-
readonly kind: ApiErrorKind;
|
|
39
|
-
readonly httpStatus?: number;
|
|
40
|
-
readonly responseBody?: unknown;
|
|
41
|
-
readonly service: string;
|
|
42
|
-
readonly method: string;
|
|
43
|
-
constructor(opts: {
|
|
44
|
-
kind: ApiErrorKind;
|
|
45
|
-
message: string;
|
|
46
|
-
httpStatus?: number;
|
|
47
|
-
responseBody?: unknown;
|
|
48
|
-
service: string;
|
|
49
|
-
method: string;
|
|
50
|
-
cause?: unknown;
|
|
51
|
-
});
|
|
52
|
-
}
|
|
53
|
-
export declare function createRequestHandler(options?: RequestHandlerOptions): RequestHandler;
|
|
54
|
-
//# sourceMappingURL=request.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/client/request.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAKH,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,GAAG,OAAO,EACvC,OAAO,EAAE,WAAW,EACpB,IAAI,EAAE,WAAW,KACd,OAAO,CAAC,CAAC,CAAC,CAAC;AAEhB,MAAM,WAAW,UAAU;IACzB,cAAc,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;IACpC,eAAe,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;IACrC,SAAS,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/D,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,cAAc,CAAC,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,KAAK,IAAI,CAAC;IACvD,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;AAE1D,qBAAa,QAAS,SAAQ,KAAK;IACjC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAChC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAEZ,IAAI,EAAE;QAChB,IAAI,EAAE,YAAY,CAAC;QACnB,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB;CASF;AASD,wBAAgB,oBAAoB,CAClC,OAAO,GAAE,qBAA0B,GAClC,cAAc,CAqJhB"}
|
package/dist/client/request.js
DELETED
|
@@ -1,150 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @servora/proto-utils/client — 通用 HTTP 请求处理器
|
|
3
|
-
*
|
|
4
|
-
* 为 proto 生成的 TypeScript client 提供标准 RequestHandler 实现,包含:
|
|
5
|
-
* - Bearer token 自动注入
|
|
6
|
-
* - Token 自动刷新(单例防重复)
|
|
7
|
-
* - 结构化 ApiError(区分 http / network / timeout)
|
|
8
|
-
* - 全局 onError 回调(延迟到宏任务,避免与 toast.promise 竞态)
|
|
9
|
-
*
|
|
10
|
-
* 消费方通过 @servora/proto-utils 使用本实现,ofetch 由本包依赖提供。
|
|
11
|
-
*/
|
|
12
|
-
import { ofetch } from "ofetch";
|
|
13
|
-
export class ApiError extends Error {
|
|
14
|
-
kind;
|
|
15
|
-
httpStatus;
|
|
16
|
-
responseBody;
|
|
17
|
-
service;
|
|
18
|
-
method;
|
|
19
|
-
constructor(opts) {
|
|
20
|
-
super(opts.message, { cause: opts.cause });
|
|
21
|
-
this.name = "ApiError";
|
|
22
|
-
this.kind = opts.kind;
|
|
23
|
-
this.httpStatus = opts.httpStatus;
|
|
24
|
-
this.responseBody = opts.responseBody;
|
|
25
|
-
this.service = opts.service;
|
|
26
|
-
this.method = opts.method;
|
|
27
|
-
}
|
|
28
|
-
}
|
|
29
|
-
function ensureLeadingSlash(path) {
|
|
30
|
-
return path.startsWith("/") ? path : `/${path}`;
|
|
31
|
-
}
|
|
32
|
-
const REFRESH_PATH = "/v1/auth/refresh-token";
|
|
33
|
-
const AUTH_PATH_PREFIX = "/v1/auth/";
|
|
34
|
-
export function createRequestHandler(options = {}) {
|
|
35
|
-
const { baseUrl = "", tokenStore, contextHeaders, timeoutMs = 30_000, onError, autoRefreshToken = false, } = options;
|
|
36
|
-
let refreshPromise = null;
|
|
37
|
-
async function tryRefreshToken() {
|
|
38
|
-
if (!tokenStore)
|
|
39
|
-
return false;
|
|
40
|
-
const refreshToken = tokenStore.getRefreshToken();
|
|
41
|
-
if (!refreshToken)
|
|
42
|
-
return false;
|
|
43
|
-
if (refreshPromise)
|
|
44
|
-
return refreshPromise;
|
|
45
|
-
refreshPromise = (async () => {
|
|
46
|
-
try {
|
|
47
|
-
const data = await ofetch(REFRESH_PATH, {
|
|
48
|
-
baseURL: baseUrl,
|
|
49
|
-
method: "POST",
|
|
50
|
-
body: { refreshToken },
|
|
51
|
-
timeout: timeoutMs,
|
|
52
|
-
});
|
|
53
|
-
tokenStore.setTokens(data.accessToken, data.refreshToken);
|
|
54
|
-
return true;
|
|
55
|
-
}
|
|
56
|
-
catch {
|
|
57
|
-
tokenStore.clear();
|
|
58
|
-
return false;
|
|
59
|
-
}
|
|
60
|
-
finally {
|
|
61
|
-
refreshPromise = null;
|
|
62
|
-
}
|
|
63
|
-
})();
|
|
64
|
-
return refreshPromise;
|
|
65
|
-
}
|
|
66
|
-
async function doRequest(request, meta, isRetry = false) {
|
|
67
|
-
const headers = {
|
|
68
|
-
Accept: "application/protojson",
|
|
69
|
-
};
|
|
70
|
-
if (request.body) {
|
|
71
|
-
headers["Content-Type"] = "application/protojson";
|
|
72
|
-
}
|
|
73
|
-
if (tokenStore) {
|
|
74
|
-
const token = tokenStore.getAccessToken();
|
|
75
|
-
if (token) {
|
|
76
|
-
headers.Authorization = `Bearer ${token}`;
|
|
77
|
-
}
|
|
78
|
-
}
|
|
79
|
-
if (contextHeaders) {
|
|
80
|
-
Object.assign(headers, contextHeaders(meta));
|
|
81
|
-
}
|
|
82
|
-
const fetchOptions = {
|
|
83
|
-
baseURL: baseUrl,
|
|
84
|
-
method: request.method,
|
|
85
|
-
headers,
|
|
86
|
-
responseType: "json",
|
|
87
|
-
timeout: timeoutMs,
|
|
88
|
-
};
|
|
89
|
-
if (request.body) {
|
|
90
|
-
fetchOptions.body = request.body;
|
|
91
|
-
}
|
|
92
|
-
const normalizedPath = ensureLeadingSlash(request.path);
|
|
93
|
-
try {
|
|
94
|
-
return await ofetch(normalizedPath, fetchOptions);
|
|
95
|
-
}
|
|
96
|
-
catch (err) {
|
|
97
|
-
const fetchError = err != null && typeof err === "object"
|
|
98
|
-
? err
|
|
99
|
-
: {};
|
|
100
|
-
const response = fetchError.response;
|
|
101
|
-
if (response) {
|
|
102
|
-
const status = response.status;
|
|
103
|
-
const body = response._data;
|
|
104
|
-
const apiErr = new ApiError({
|
|
105
|
-
kind: "http",
|
|
106
|
-
message: `HTTP ${status} on ${meta.service}.${meta.method}`,
|
|
107
|
-
httpStatus: status,
|
|
108
|
-
responseBody: body,
|
|
109
|
-
service: meta.service,
|
|
110
|
-
method: meta.method,
|
|
111
|
-
cause: err,
|
|
112
|
-
});
|
|
113
|
-
if (autoRefreshToken &&
|
|
114
|
-
status === 401 &&
|
|
115
|
-
!isRetry &&
|
|
116
|
-
!normalizedPath.startsWith(AUTH_PATH_PREFIX)) {
|
|
117
|
-
const refreshed = await tryRefreshToken();
|
|
118
|
-
if (refreshed) {
|
|
119
|
-
return doRequest(request, meta, true);
|
|
120
|
-
}
|
|
121
|
-
}
|
|
122
|
-
// 延迟到宏任务再调 onError,让 promise 链先跑完(含 toast.promise 的 _mark),
|
|
123
|
-
// 避免全局 handler 与 sonner.promise error callback 同时弹出双重 toast。
|
|
124
|
-
if (onError) {
|
|
125
|
-
const _err = apiErr;
|
|
126
|
-
setTimeout(() => onError(_err, meta), 0);
|
|
127
|
-
}
|
|
128
|
-
throw apiErr;
|
|
129
|
-
}
|
|
130
|
-
const rawMessage = typeof fetchError.message === "string" ? fetchError.message : "";
|
|
131
|
-
const kind = rawMessage.toLowerCase().includes("timeout")
|
|
132
|
-
? "timeout"
|
|
133
|
-
: "network";
|
|
134
|
-
const apiErr = new ApiError({
|
|
135
|
-
kind,
|
|
136
|
-
message: `${kind} error on ${meta.service}.${meta.method}: ${rawMessage}`,
|
|
137
|
-
service: meta.service,
|
|
138
|
-
method: meta.method,
|
|
139
|
-
cause: err,
|
|
140
|
-
});
|
|
141
|
-
if (onError) {
|
|
142
|
-
const _err = apiErr;
|
|
143
|
-
setTimeout(() => onError(_err, meta), 0);
|
|
144
|
-
}
|
|
145
|
-
throw apiErr;
|
|
146
|
-
}
|
|
147
|
-
}
|
|
148
|
-
return doRequest;
|
|
149
|
-
}
|
|
150
|
-
//# sourceMappingURL=request.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"request.js","sourceRoot":"","sources":["../../src/client/request.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAGH,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAoChC,MAAM,OAAO,QAAS,SAAQ,KAAK;IACxB,IAAI,CAAe;IACnB,UAAU,CAAU;IACpB,YAAY,CAAW;IACvB,OAAO,CAAS;IAChB,MAAM,CAAS;IAExB,YAAY,IAQX;QACC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QAC3C,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IAC5B,CAAC;CACF;AAED,SAAS,kBAAkB,CAAC,IAAY;IACtC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;AAClD,CAAC;AAED,MAAM,YAAY,GAAG,wBAAwB,CAAC;AAC9C,MAAM,gBAAgB,GAAG,WAAW,CAAC;AAErC,MAAM,UAAU,oBAAoB,CAClC,UAAiC,EAAE;IAEnC,MAAM,EACJ,OAAO,GAAG,EAAE,EACZ,UAAU,EACV,cAAc,EACd,SAAS,GAAG,MAAM,EAClB,OAAO,EACP,gBAAgB,GAAG,KAAK,GACzB,GAAG,OAAO,CAAC;IAEZ,IAAI,cAAc,GAA4B,IAAI,CAAC;IAEnD,KAAK,UAAU,eAAe;QAC5B,IAAI,CAAC,UAAU;YAAE,OAAO,KAAK,CAAC;QAC9B,MAAM,YAAY,GAAG,UAAU,CAAC,eAAe,EAAE,CAAC;QAClD,IAAI,CAAC,YAAY;YAAE,OAAO,KAAK,CAAC;QAEhC,IAAI,cAAc;YAAE,OAAO,cAAc,CAAC;QAE1C,cAAc,GAAG,CAAC,KAAK,IAAI,EAAE;YAC3B,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,MAAM,CAGtB,YAAY,EAAE;oBACf,OAAO,EAAE,OAAO;oBAChB,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,EAAE,YAAY,EAAE;oBACtB,OAAO,EAAE,SAAS;iBACnB,CAAC,CAAC;gBACH,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;gBAC1D,OAAO,IAAI,CAAC;YACd,CAAC;YAAC,MAAM,CAAC;gBACP,UAAU,CAAC,KAAK,EAAE,CAAC;gBACnB,OAAO,KAAK,CAAC;YACf,CAAC;oBAAS,CAAC;gBACT,cAAc,GAAG,IAAI,CAAC;YACxB,CAAC;QACH,CAAC,CAAC,EAAE,CAAC;QAEL,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,KAAK,UAAU,SAAS,CACtB,OAAoB,EACpB,IAAiB,EACjB,OAAO,GAAG,KAAK;QAEf,MAAM,OAAO,GAA2B;YACtC,MAAM,EAAE,uBAAuB;SAChC,CAAC;QAEF,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,OAAO,CAAC,cAAc,CAAC,GAAG,uBAAuB,CAAC;QACpD,CAAC;QAED,IAAI,UAAU,EAAE,CAAC;YACf,MAAM,KAAK,GAAG,UAAU,CAAC,cAAc,EAAE,CAAC;YAC1C,IAAI,KAAK,EAAE,CAAC;gBACV,OAAO,CAAC,aAAa,GAAG,UAAU,KAAK,EAAE,CAAC;YAC5C,CAAC;QACH,CAAC;QAED,IAAI,cAAc,EAAE,CAAC;YACnB,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QAC/C,CAAC;QAED,MAAM,YAAY,GAA4B;YAC5C,OAAO,EAAE,OAAO;YAChB,MAAM,EAAE,OAAO,CAAC,MAAgC;YAChD,OAAO;YACP,YAAY,EAAE,MAAM;YACpB,OAAO,EAAE,SAAS;SACnB,CAAC;QAEF,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,YAAY,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACnC,CAAC;QAED,MAAM,cAAc,GAAG,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAExD,IAAI,CAAC;YACH,OAAO,MAAM,MAAM,CAAI,cAAc,EAAE,YAAY,CAAC,CAAC;QACvD,CAAC;QAAC,OAAO,GAAY,EAAE,CAAC;YACtB,MAAM,UAAU,GACd,GAAG,IAAI,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ;gBACpC,CAAC,CAAE,GAA+B;gBAClC,CAAC,CAAC,EAAE,CAAC;YACT,MAAM,QAAQ,GAAG,UAAU,CAAC,QAEf,CAAC;YAEd,IAAI,QAAQ,EAAE,CAAC;gBACb,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;gBAC/B,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC;gBAE5B,MAAM,MAAM,GAAG,IAAI,QAAQ,CAAC;oBAC1B,IAAI,EAAE,MAAM;oBACZ,OAAO,EAAE,QAAQ,MAAM,OAAO,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,EAAE;oBAC3D,UAAU,EAAE,MAAM;oBAClB,YAAY,EAAE,IAAI;oBAClB,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,KAAK,EAAE,GAAG;iBACX,CAAC,CAAC;gBAEH,IACE,gBAAgB;oBAChB,MAAM,KAAK,GAAG;oBACd,CAAC,OAAO;oBACR,CAAC,cAAc,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAC5C,CAAC;oBACD,MAAM,SAAS,GAAG,MAAM,eAAe,EAAE,CAAC;oBAC1C,IAAI,SAAS,EAAE,CAAC;wBACd,OAAO,SAAS,CAAI,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;oBAC3C,CAAC;gBACH,CAAC;gBAED,4DAA4D;gBAC5D,6DAA6D;gBAC7D,IAAI,OAAO,EAAE,CAAC;oBACZ,MAAM,IAAI,GAAG,MAAM,CAAC;oBACpB,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC3C,CAAC;gBACD,MAAM,MAAM,CAAC;YACf,CAAC;YAED,MAAM,UAAU,GACd,OAAO,UAAU,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YACnE,MAAM,IAAI,GAAiB,UAAU,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC;gBACrE,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,SAAS,CAAC;YAEd,MAAM,MAAM,GAAG,IAAI,QAAQ,CAAC;gBAC1B,IAAI;gBACJ,OAAO,EAAE,GAAG,IAAI,aAAa,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,KAAK,UAAU,EAAE;gBACzE,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,KAAK,EAAE,GAAG;aACX,CAAC,CAAC;YACH,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,IAAI,GAAG,MAAM,CAAC;gBACpB,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;YAC3C,CAAC;YACD,MAAM,MAAM,CAAC;QACf,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC"}
|
package/src/client/errors.ts
DELETED
|
@@ -1,54 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Kratos 错误解析工具
|
|
3
|
-
*
|
|
4
|
-
* Kratos 统一错误格式:{ code, reason, message, metadata? }
|
|
5
|
-
* 所有使用 protoc-gen-go-errors 生成的服务均输出此格式。
|
|
6
|
-
*/
|
|
7
|
-
import type { ApiError } from "./request.js";
|
|
8
|
-
|
|
9
|
-
export interface KratosErrorBody {
|
|
10
|
-
code: number;
|
|
11
|
-
reason: string;
|
|
12
|
-
message: string;
|
|
13
|
-
metadata?: Record<string, string>;
|
|
14
|
-
}
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
* 从 ApiError 中提取 Kratos 结构化错误体。
|
|
18
|
-
* 非 HTTP 错误、或响应体不符合格式时返回 null。
|
|
19
|
-
*/
|
|
20
|
-
export function parseKratosError(err: ApiError): KratosErrorBody | null {
|
|
21
|
-
if (err.kind !== "http" || !err.responseBody) return null;
|
|
22
|
-
const body = err.responseBody as Record<string, unknown>;
|
|
23
|
-
if (
|
|
24
|
-
typeof body.code !== "number" ||
|
|
25
|
-
typeof body.reason !== "string" ||
|
|
26
|
-
typeof body.message !== "string"
|
|
27
|
-
)
|
|
28
|
-
return null;
|
|
29
|
-
return body as unknown as KratosErrorBody;
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
/**
|
|
33
|
-
* 判断 ApiError 是否为指定的 Kratos reason。
|
|
34
|
-
*
|
|
35
|
-
* @example
|
|
36
|
-
* if (isKratosReason(err, 'EMAIL_NOT_VERIFIED')) { ... }
|
|
37
|
-
*/
|
|
38
|
-
export function isKratosReason(err: ApiError, reason: string): boolean {
|
|
39
|
-
return parseKratosError(err)?.reason === reason;
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
/**
|
|
43
|
-
* 提取用户可读的错误消息,含 network / timeout 降级处理。
|
|
44
|
-
*
|
|
45
|
-
* @param fallback 当无法提取有效消息时的兜底文案,默认 '操作失败'
|
|
46
|
-
*/
|
|
47
|
-
export function kratosMessage(err: ApiError, fallback = "操作失败"): string {
|
|
48
|
-
if (err.kind === "network") return "网络连接失败,请检查网络设置";
|
|
49
|
-
if (err.kind === "timeout") return "请求超时,请稍后重试";
|
|
50
|
-
return (
|
|
51
|
-
parseKratosError(err)?.message ??
|
|
52
|
-
(err.httpStatus ? `请求失败(HTTP ${err.httpStatus})` : fallback)
|
|
53
|
-
);
|
|
54
|
-
}
|
package/src/client/index.ts
DELETED
package/src/client/request.ts
DELETED
|
@@ -1,234 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @servora/proto-utils/client — 通用 HTTP 请求处理器
|
|
3
|
-
*
|
|
4
|
-
* 为 proto 生成的 TypeScript client 提供标准 RequestHandler 实现,包含:
|
|
5
|
-
* - Bearer token 自动注入
|
|
6
|
-
* - Token 自动刷新(单例防重复)
|
|
7
|
-
* - 结构化 ApiError(区分 http / network / timeout)
|
|
8
|
-
* - 全局 onError 回调(延迟到宏任务,避免与 toast.promise 竞态)
|
|
9
|
-
*
|
|
10
|
-
* 消费方通过 @servora/proto-utils 使用本实现,ofetch 由本包依赖提供。
|
|
11
|
-
*/
|
|
12
|
-
|
|
13
|
-
import type { FetchOptions } from "ofetch";
|
|
14
|
-
import { ofetch } from "ofetch";
|
|
15
|
-
|
|
16
|
-
export type RequestType = {
|
|
17
|
-
path: string;
|
|
18
|
-
method: string;
|
|
19
|
-
body: string | null;
|
|
20
|
-
};
|
|
21
|
-
|
|
22
|
-
export type RequestMeta = {
|
|
23
|
-
service: string;
|
|
24
|
-
method: string;
|
|
25
|
-
};
|
|
26
|
-
|
|
27
|
-
export type RequestHandler = <T = unknown>(
|
|
28
|
-
request: RequestType,
|
|
29
|
-
meta: RequestMeta,
|
|
30
|
-
) => Promise<T>;
|
|
31
|
-
|
|
32
|
-
export interface TokenStore {
|
|
33
|
-
getAccessToken: () => string | null;
|
|
34
|
-
getRefreshToken: () => string | null;
|
|
35
|
-
setTokens: (accessToken: string, refreshToken: string) => void;
|
|
36
|
-
clear: () => void;
|
|
37
|
-
}
|
|
38
|
-
|
|
39
|
-
export interface RequestHandlerOptions {
|
|
40
|
-
baseUrl?: string;
|
|
41
|
-
tokenStore?: TokenStore;
|
|
42
|
-
contextHeaders?: (meta: RequestMeta) => Record<string, string>;
|
|
43
|
-
timeoutMs?: number;
|
|
44
|
-
onError?: (error: ApiError, meta: RequestMeta) => void;
|
|
45
|
-
autoRefreshToken?: boolean;
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
export type ApiErrorKind = "http" | "network" | "timeout";
|
|
49
|
-
|
|
50
|
-
export class ApiError extends Error {
|
|
51
|
-
readonly kind: ApiErrorKind;
|
|
52
|
-
readonly httpStatus?: number;
|
|
53
|
-
readonly responseBody?: unknown;
|
|
54
|
-
readonly service: string;
|
|
55
|
-
readonly method: string;
|
|
56
|
-
|
|
57
|
-
constructor(opts: {
|
|
58
|
-
kind: ApiErrorKind;
|
|
59
|
-
message: string;
|
|
60
|
-
httpStatus?: number;
|
|
61
|
-
responseBody?: unknown;
|
|
62
|
-
service: string;
|
|
63
|
-
method: string;
|
|
64
|
-
cause?: unknown;
|
|
65
|
-
}) {
|
|
66
|
-
super(opts.message, { cause: opts.cause });
|
|
67
|
-
this.name = "ApiError";
|
|
68
|
-
this.kind = opts.kind;
|
|
69
|
-
this.httpStatus = opts.httpStatus;
|
|
70
|
-
this.responseBody = opts.responseBody;
|
|
71
|
-
this.service = opts.service;
|
|
72
|
-
this.method = opts.method;
|
|
73
|
-
}
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
function ensureLeadingSlash(path: string): string {
|
|
77
|
-
return path.startsWith("/") ? path : `/${path}`;
|
|
78
|
-
}
|
|
79
|
-
|
|
80
|
-
const REFRESH_PATH = "/v1/auth/refresh-token";
|
|
81
|
-
const AUTH_PATH_PREFIX = "/v1/auth/";
|
|
82
|
-
|
|
83
|
-
export function createRequestHandler(
|
|
84
|
-
options: RequestHandlerOptions = {},
|
|
85
|
-
): RequestHandler {
|
|
86
|
-
const {
|
|
87
|
-
baseUrl = "",
|
|
88
|
-
tokenStore,
|
|
89
|
-
contextHeaders,
|
|
90
|
-
timeoutMs = 30_000,
|
|
91
|
-
onError,
|
|
92
|
-
autoRefreshToken = false,
|
|
93
|
-
} = options;
|
|
94
|
-
|
|
95
|
-
let refreshPromise: Promise<boolean> | null = null;
|
|
96
|
-
|
|
97
|
-
async function tryRefreshToken(): Promise<boolean> {
|
|
98
|
-
if (!tokenStore) return false;
|
|
99
|
-
const refreshToken = tokenStore.getRefreshToken();
|
|
100
|
-
if (!refreshToken) return false;
|
|
101
|
-
|
|
102
|
-
if (refreshPromise) return refreshPromise;
|
|
103
|
-
|
|
104
|
-
refreshPromise = (async () => {
|
|
105
|
-
try {
|
|
106
|
-
const data = await ofetch<{
|
|
107
|
-
accessToken: string;
|
|
108
|
-
refreshToken: string;
|
|
109
|
-
}>(REFRESH_PATH, {
|
|
110
|
-
baseURL: baseUrl,
|
|
111
|
-
method: "POST",
|
|
112
|
-
body: { refreshToken },
|
|
113
|
-
timeout: timeoutMs,
|
|
114
|
-
});
|
|
115
|
-
tokenStore.setTokens(data.accessToken, data.refreshToken);
|
|
116
|
-
return true;
|
|
117
|
-
} catch {
|
|
118
|
-
tokenStore.clear();
|
|
119
|
-
return false;
|
|
120
|
-
} finally {
|
|
121
|
-
refreshPromise = null;
|
|
122
|
-
}
|
|
123
|
-
})();
|
|
124
|
-
|
|
125
|
-
return refreshPromise;
|
|
126
|
-
}
|
|
127
|
-
|
|
128
|
-
async function doRequest<T = unknown>(
|
|
129
|
-
request: RequestType,
|
|
130
|
-
meta: RequestMeta,
|
|
131
|
-
isRetry = false,
|
|
132
|
-
): Promise<T> {
|
|
133
|
-
const headers: Record<string, string> = {
|
|
134
|
-
Accept: "application/protojson",
|
|
135
|
-
};
|
|
136
|
-
|
|
137
|
-
if (request.body) {
|
|
138
|
-
headers["Content-Type"] = "application/protojson";
|
|
139
|
-
}
|
|
140
|
-
|
|
141
|
-
if (tokenStore) {
|
|
142
|
-
const token = tokenStore.getAccessToken();
|
|
143
|
-
if (token) {
|
|
144
|
-
headers.Authorization = `Bearer ${token}`;
|
|
145
|
-
}
|
|
146
|
-
}
|
|
147
|
-
|
|
148
|
-
if (contextHeaders) {
|
|
149
|
-
Object.assign(headers, contextHeaders(meta));
|
|
150
|
-
}
|
|
151
|
-
|
|
152
|
-
const fetchOptions: FetchOptions<"json", T> = {
|
|
153
|
-
baseURL: baseUrl,
|
|
154
|
-
method: request.method as FetchOptions["method"],
|
|
155
|
-
headers,
|
|
156
|
-
responseType: "json",
|
|
157
|
-
timeout: timeoutMs,
|
|
158
|
-
};
|
|
159
|
-
|
|
160
|
-
if (request.body) {
|
|
161
|
-
fetchOptions.body = request.body;
|
|
162
|
-
}
|
|
163
|
-
|
|
164
|
-
const normalizedPath = ensureLeadingSlash(request.path);
|
|
165
|
-
|
|
166
|
-
try {
|
|
167
|
-
return await ofetch<T>(normalizedPath, fetchOptions);
|
|
168
|
-
} catch (err: unknown) {
|
|
169
|
-
const fetchError =
|
|
170
|
-
err != null && typeof err === "object"
|
|
171
|
-
? (err as Record<string, unknown>)
|
|
172
|
-
: {};
|
|
173
|
-
const response = fetchError.response as
|
|
174
|
-
| { status: number; _data?: unknown }
|
|
175
|
-
| undefined;
|
|
176
|
-
|
|
177
|
-
if (response) {
|
|
178
|
-
const status = response.status;
|
|
179
|
-
const body = response._data;
|
|
180
|
-
|
|
181
|
-
const apiErr = new ApiError({
|
|
182
|
-
kind: "http",
|
|
183
|
-
message: `HTTP ${status} on ${meta.service}.${meta.method}`,
|
|
184
|
-
httpStatus: status,
|
|
185
|
-
responseBody: body,
|
|
186
|
-
service: meta.service,
|
|
187
|
-
method: meta.method,
|
|
188
|
-
cause: err,
|
|
189
|
-
});
|
|
190
|
-
|
|
191
|
-
if (
|
|
192
|
-
autoRefreshToken &&
|
|
193
|
-
status === 401 &&
|
|
194
|
-
!isRetry &&
|
|
195
|
-
!normalizedPath.startsWith(AUTH_PATH_PREFIX)
|
|
196
|
-
) {
|
|
197
|
-
const refreshed = await tryRefreshToken();
|
|
198
|
-
if (refreshed) {
|
|
199
|
-
return doRequest<T>(request, meta, true);
|
|
200
|
-
}
|
|
201
|
-
}
|
|
202
|
-
|
|
203
|
-
// 延迟到宏任务再调 onError,让 promise 链先跑完(含 toast.promise 的 _mark),
|
|
204
|
-
// 避免全局 handler 与 sonner.promise error callback 同时弹出双重 toast。
|
|
205
|
-
if (onError) {
|
|
206
|
-
const _err = apiErr;
|
|
207
|
-
setTimeout(() => onError(_err, meta), 0);
|
|
208
|
-
}
|
|
209
|
-
throw apiErr;
|
|
210
|
-
}
|
|
211
|
-
|
|
212
|
-
const rawMessage =
|
|
213
|
-
typeof fetchError.message === "string" ? fetchError.message : "";
|
|
214
|
-
const kind: ApiErrorKind = rawMessage.toLowerCase().includes("timeout")
|
|
215
|
-
? "timeout"
|
|
216
|
-
: "network";
|
|
217
|
-
|
|
218
|
-
const apiErr = new ApiError({
|
|
219
|
-
kind,
|
|
220
|
-
message: `${kind} error on ${meta.service}.${meta.method}: ${rawMessage}`,
|
|
221
|
-
service: meta.service,
|
|
222
|
-
method: meta.method,
|
|
223
|
-
cause: err,
|
|
224
|
-
});
|
|
225
|
-
if (onError) {
|
|
226
|
-
const _err = apiErr;
|
|
227
|
-
setTimeout(() => onError(_err, meta), 0);
|
|
228
|
-
}
|
|
229
|
-
throw apiErr;
|
|
230
|
-
}
|
|
231
|
-
}
|
|
232
|
-
|
|
233
|
-
return doRequest;
|
|
234
|
-
}
|