@servora/proto-utils 0.1.1 → 0.1.3

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.
Files changed (167) hide show
  1. package/dist/client/request.d.ts +1 -1
  2. package/dist/client/request.d.ts.map +1 -1
  3. package/dist/client/request.js +3 -2
  4. package/dist/client/request.js.map +1 -1
  5. package/dist/crud/index.d.ts +53 -0
  6. package/dist/crud/index.d.ts.map +1 -0
  7. package/dist/crud/index.js +127 -0
  8. package/dist/crud/index.js.map +1 -0
  9. package/dist/gen/servora/audit/v1/index.d.ts +19 -22
  10. package/dist/gen/servora/audit/v1/index.d.ts.map +1 -1
  11. package/dist/gen/servora/audit/v1/index.js +10 -2
  12. package/dist/gen/servora/audit/v1/index.js.map +1 -1
  13. package/dist/gen/servora/authn/audit/v1/index.d.ts +34 -0
  14. package/dist/gen/servora/authn/audit/v1/index.d.ts.map +1 -0
  15. package/dist/gen/servora/authn/audit/v1/index.js +14 -0
  16. package/dist/gen/servora/authn/audit/v1/index.js.map +1 -0
  17. package/dist/gen/servora/authn/v1/index.d.ts +21 -3
  18. package/dist/gen/servora/authn/v1/index.d.ts.map +1 -1
  19. package/dist/gen/servora/authn/v1/index.js +10 -2
  20. package/dist/gen/servora/authn/v1/index.js.map +1 -1
  21. package/dist/gen/servora/authz/audit/v1/index.d.ts +30 -0
  22. package/dist/gen/servora/authz/audit/v1/index.d.ts.map +1 -0
  23. package/dist/gen/servora/authz/audit/v1/index.js +14 -0
  24. package/dist/gen/servora/authz/audit/v1/index.js.map +1 -0
  25. package/dist/gen/servora/authz/openfga/audit/v1/index.d.ts +31 -0
  26. package/dist/gen/servora/authz/openfga/audit/v1/index.d.ts.map +1 -0
  27. package/dist/gen/servora/authz/openfga/audit/v1/index.js +14 -0
  28. package/dist/gen/servora/authz/openfga/audit/v1/index.js.map +1 -0
  29. package/dist/gen/servora/authz/v1/index.d.ts +23 -5
  30. package/dist/gen/servora/authz/v1/index.d.ts.map +1 -1
  31. package/dist/gen/servora/authz/v1/index.js +10 -2
  32. package/dist/gen/servora/authz/v1/index.js.map +1 -1
  33. package/dist/gen/servora/cloudevents/v1/index.d.ts +28 -11
  34. package/dist/gen/servora/cloudevents/v1/index.d.ts.map +1 -1
  35. package/dist/gen/servora/cloudevents/v1/index.js +10 -2
  36. package/dist/gen/servora/cloudevents/v1/index.js.map +1 -1
  37. package/dist/gen/servora/conf/v1/index.d.ts +22 -4
  38. package/dist/gen/servora/conf/v1/index.d.ts.map +1 -1
  39. package/dist/gen/servora/conf/v1/index.js +10 -2
  40. package/dist/gen/servora/conf/v1/index.js.map +1 -1
  41. package/dist/gen/servora/contrib/db/clickhouse/v1/index.d.ts +39 -0
  42. package/dist/gen/servora/contrib/db/clickhouse/v1/index.d.ts.map +1 -0
  43. package/dist/gen/servora/contrib/db/clickhouse/v1/index.js +14 -0
  44. package/dist/gen/servora/contrib/db/clickhouse/v1/index.js.map +1 -0
  45. package/dist/gen/servora/contrib/db/redis/v1/index.d.ts +30 -0
  46. package/dist/gen/servora/contrib/db/redis/v1/index.d.ts.map +1 -0
  47. package/dist/gen/servora/contrib/db/redis/v1/index.js +14 -0
  48. package/dist/gen/servora/contrib/db/redis/v1/index.js.map +1 -0
  49. package/dist/gen/servora/contrib/kafka/v1/index.d.ts +45 -0
  50. package/dist/gen/servora/contrib/kafka/v1/index.d.ts.map +1 -0
  51. package/dist/gen/servora/contrib/kafka/v1/index.js +14 -0
  52. package/dist/gen/servora/contrib/kafka/v1/index.js.map +1 -0
  53. package/dist/gen/servora/contrib/mail/v1/index.d.ts +37 -0
  54. package/dist/gen/servora/contrib/mail/v1/index.d.ts.map +1 -0
  55. package/dist/gen/servora/contrib/mail/v1/index.js +14 -0
  56. package/dist/gen/servora/contrib/mail/v1/index.js.map +1 -0
  57. package/dist/gen/servora/core/v1/index.d.ts +106 -89
  58. package/dist/gen/servora/core/v1/index.d.ts.map +1 -1
  59. package/dist/gen/servora/core/v1/index.js +10 -2
  60. package/dist/gen/servora/core/v1/index.js.map +1 -1
  61. package/dist/gen/servora/crud/v1/index.d.ts +40 -0
  62. package/dist/gen/servora/crud/v1/index.d.ts.map +1 -0
  63. package/dist/gen/servora/crud/v1/index.js +14 -0
  64. package/dist/gen/servora/crud/v1/index.js.map +1 -0
  65. package/dist/gen/servora/errors/v1/index.d.ts +19 -0
  66. package/dist/gen/servora/errors/v1/index.d.ts.map +1 -0
  67. package/dist/gen/servora/errors/v1/index.js +14 -0
  68. package/dist/gen/servora/errors/v1/index.js.map +1 -0
  69. package/dist/gen/servora/example/v1/example.crud.d.ts +29 -0
  70. package/dist/gen/servora/example/v1/example.crud.d.ts.map +1 -0
  71. package/dist/gen/servora/example/v1/example.crud.js +54 -0
  72. package/dist/gen/servora/example/v1/example.crud.js.map +1 -0
  73. package/dist/gen/servora/example/v1/index.d.ts +86 -0
  74. package/dist/gen/servora/example/v1/index.d.ts.map +1 -0
  75. package/dist/gen/servora/example/v1/index.js +158 -0
  76. package/dist/gen/servora/example/v1/index.js.map +1 -0
  77. package/dist/gen/servora/obs/audit/v1/index.d.ts +22 -4
  78. package/dist/gen/servora/obs/audit/v1/index.d.ts.map +1 -1
  79. package/dist/gen/servora/obs/audit/v1/index.js +10 -2
  80. package/dist/gen/servora/obs/audit/v1/index.js.map +1 -1
  81. package/dist/gen/servora/security/authn/oidc/v1/index.d.ts +22 -4
  82. package/dist/gen/servora/security/authn/oidc/v1/index.d.ts.map +1 -1
  83. package/dist/gen/servora/security/authn/oidc/v1/index.js +10 -2
  84. package/dist/gen/servora/security/authn/oidc/v1/index.js.map +1 -1
  85. package/dist/gen/servora/security/authz/openfga/v1/index.d.ts +22 -4
  86. package/dist/gen/servora/security/authz/openfga/v1/index.d.ts.map +1 -1
  87. package/dist/gen/servora/security/authz/openfga/v1/index.js +10 -2
  88. package/dist/gen/servora/security/authz/openfga/v1/index.js.map +1 -1
  89. package/dist/gen/servora/security/jwt/v1/index.d.ts +24 -6
  90. package/dist/gen/servora/security/jwt/v1/index.d.ts.map +1 -1
  91. package/dist/gen/servora/security/jwt/v1/index.js +10 -2
  92. package/dist/gen/servora/security/jwt/v1/index.js.map +1 -1
  93. package/dist/gen/servora/security/tls/v1/index.d.ts +22 -4
  94. package/dist/gen/servora/security/tls/v1/index.d.ts.map +1 -1
  95. package/dist/gen/servora/security/tls/v1/index.js +10 -2
  96. package/dist/gen/servora/security/tls/v1/index.js.map +1 -1
  97. package/dist/gen/servora/transport/http/cors/v1/index.d.ts +24 -7
  98. package/dist/gen/servora/transport/http/cors/v1/index.d.ts.map +1 -1
  99. package/dist/gen/servora/transport/http/cors/v1/index.js +10 -2
  100. package/dist/gen/servora/transport/http/cors/v1/index.js.map +1 -1
  101. package/dist/index.d.ts +0 -1
  102. package/dist/index.d.ts.map +1 -1
  103. package/dist/index.js +0 -1
  104. package/dist/index.js.map +1 -1
  105. package/package.json +5 -4
  106. package/src/client/request.ts +10 -9
  107. package/src/crud/AGENTS.md +24 -0
  108. package/src/crud/index.ts +206 -0
  109. package/src/gen/servora/audit/v1/index.ts +50 -54
  110. package/src/gen/servora/authn/audit/v1/index.ts +78 -0
  111. package/src/gen/servora/authn/v1/index.ts +44 -8
  112. package/src/gen/servora/authz/audit/v1/index.ts +76 -0
  113. package/src/gen/servora/authz/openfga/audit/v1/index.ts +65 -0
  114. package/src/gen/servora/authz/v1/index.ts +49 -13
  115. package/src/gen/servora/cloudevents/v1/index.ts +49 -13
  116. package/src/gen/servora/conf/v1/index.ts +42 -6
  117. package/src/gen/servora/contrib/db/clickhouse/v1/index.ts +69 -0
  118. package/src/gen/servora/contrib/db/redis/v1/index.ts +59 -0
  119. package/src/gen/servora/contrib/kafka/v1/index.ts +77 -0
  120. package/src/gen/servora/contrib/mail/v1/index.ts +68 -0
  121. package/src/gen/servora/core/v1/index.ts +134 -98
  122. package/src/gen/servora/crud/v1/index.ts +104 -0
  123. package/src/gen/servora/errors/v1/index.ts +42 -0
  124. package/src/gen/servora/example/v1/example.crud.ts +64 -0
  125. package/src/gen/servora/example/v1/index.ts +441 -0
  126. package/src/gen/servora/obs/audit/v1/index.ts +42 -6
  127. package/src/gen/servora/security/authn/oidc/v1/index.ts +42 -6
  128. package/src/gen/servora/security/authz/openfga/v1/index.ts +42 -6
  129. package/src/gen/servora/security/jwt/v1/index.ts +44 -8
  130. package/src/gen/servora/security/tls/v1/index.ts +42 -6
  131. package/src/gen/servora/transport/http/cors/v1/index.ts +45 -9
  132. package/src/index.ts +0 -1
  133. package/dist/gen/servora/infra/db/clickhouse/v1/index.d.ts +0 -22
  134. package/dist/gen/servora/infra/db/clickhouse/v1/index.d.ts.map +0 -1
  135. package/dist/gen/servora/infra/db/clickhouse/v1/index.js +0 -6
  136. package/dist/gen/servora/infra/db/clickhouse/v1/index.js.map +0 -1
  137. package/dist/gen/servora/infra/kafka/v1/index.d.ts +0 -28
  138. package/dist/gen/servora/infra/kafka/v1/index.d.ts.map +0 -1
  139. package/dist/gen/servora/infra/kafka/v1/index.js +0 -6
  140. package/dist/gen/servora/infra/kafka/v1/index.js.map +0 -1
  141. package/dist/gen/servora/infra/mail/v1/index.d.ts +0 -20
  142. package/dist/gen/servora/infra/mail/v1/index.d.ts.map +0 -1
  143. package/dist/gen/servora/infra/mail/v1/index.js +0 -6
  144. package/dist/gen/servora/infra/mail/v1/index.js.map +0 -1
  145. package/dist/gen/servora/infra/redis/v1/index.d.ts +0 -13
  146. package/dist/gen/servora/infra/redis/v1/index.d.ts.map +0 -1
  147. package/dist/gen/servora/infra/redis/v1/index.js +0 -6
  148. package/dist/gen/servora/infra/redis/v1/index.js.map +0 -1
  149. package/dist/gen/servora/mapper/v1/index.d.ts +0 -7
  150. package/dist/gen/servora/mapper/v1/index.d.ts.map +0 -1
  151. package/dist/gen/servora/mapper/v1/index.js +0 -6
  152. package/dist/gen/servora/mapper/v1/index.js.map +0 -1
  153. package/dist/gen/servora/pagination/v1/index.d.ts +0 -26
  154. package/dist/gen/servora/pagination/v1/index.d.ts.map +0 -1
  155. package/dist/gen/servora/pagination/v1/index.js +0 -6
  156. package/dist/gen/servora/pagination/v1/index.js.map +0 -1
  157. package/dist/query.d.ts +0 -57
  158. package/dist/query.d.ts.map +0 -1
  159. package/dist/query.js +0 -77
  160. package/dist/query.js.map +0 -1
  161. package/src/gen/servora/infra/db/clickhouse/v1/index.ts +0 -33
  162. package/src/gen/servora/infra/kafka/v1/index.ts +0 -41
  163. package/src/gen/servora/infra/mail/v1/index.ts +0 -32
  164. package/src/gen/servora/infra/redis/v1/index.ts +0 -23
  165. package/src/gen/servora/mapper/v1/index.ts +0 -18
  166. package/src/gen/servora/pagination/v1/index.ts +0 -37
  167. package/src/query.ts +0 -83
@@ -24,10 +24,10 @@ export type RequestMeta = {
24
24
  method: string;
25
25
  };
26
26
 
27
- export type RequestHandler = (
27
+ export type RequestHandler = <T = unknown>(
28
28
  request: RequestType,
29
29
  meta: RequestMeta,
30
- ) => Promise<unknown>;
30
+ ) => Promise<T>;
31
31
 
32
32
  export interface TokenStore {
33
33
  getAccessToken: () => string | null;
@@ -125,17 +125,17 @@ export function createRequestHandler(
125
125
  return refreshPromise;
126
126
  }
127
127
 
128
- async function doRequest(
128
+ async function doRequest<T = unknown>(
129
129
  request: RequestType,
130
130
  meta: RequestMeta,
131
131
  isRetry = false,
132
- ): Promise<unknown> {
132
+ ): Promise<T> {
133
133
  const headers: Record<string, string> = {
134
- Accept: "application/json",
134
+ Accept: "application/protojson",
135
135
  };
136
136
 
137
137
  if (request.body) {
138
- headers["Content-Type"] = "application/json";
138
+ headers["Content-Type"] = "application/protojson";
139
139
  }
140
140
 
141
141
  if (tokenStore) {
@@ -149,10 +149,11 @@ export function createRequestHandler(
149
149
  Object.assign(headers, contextHeaders(meta));
150
150
  }
151
151
 
152
- const fetchOptions: FetchOptions = {
152
+ const fetchOptions: FetchOptions<"json", T> = {
153
153
  baseURL: baseUrl,
154
154
  method: request.method as FetchOptions["method"],
155
155
  headers,
156
+ responseType: "json",
156
157
  timeout: timeoutMs,
157
158
  };
158
159
 
@@ -163,7 +164,7 @@ export function createRequestHandler(
163
164
  const normalizedPath = ensureLeadingSlash(request.path);
164
165
 
165
166
  try {
166
- return await ofetch(normalizedPath, fetchOptions);
167
+ return await ofetch<T>(normalizedPath, fetchOptions);
167
168
  } catch (err: unknown) {
168
169
  const fetchError =
169
170
  err != null && typeof err === "object"
@@ -195,7 +196,7 @@ export function createRequestHandler(
195
196
  ) {
196
197
  const refreshed = await tryRefreshToken();
197
198
  if (refreshed) {
198
- return doRequest(request, meta, true);
199
+ return doRequest<T>(request, meta, true);
199
200
  }
200
201
  }
201
202
 
@@ -0,0 +1,24 @@
1
+ # AGENTS.md - web/packages/proto-utils/src/crud/
2
+
3
+ <!-- Parent: ../../AGENTS.md -->
4
+ <!-- Updated: 2026-07-21 -->
5
+
6
+ ## 模块目的
7
+
8
+ `crud` 是 `@servora/proto-utils/crud` 的框架无关 TypeScript 运行时,供 `protoc-gen-servora-crud target=ts` 生成物消费。
9
+
10
+ ## 核心边界
11
+
12
+ - 只提供资源名错误、FieldMask、AIP filter/order 文本和无状态 pager helper。
13
+ - 不生成或持有 Proto message、HTTP client、UI hooks、业务状态、授权或持久化逻辑。
14
+ - 所有 helper 不修改调用方传入对象;字段参数必须来自生成的 `XxxFields` / `XxxUpdateFields`。
15
+ - Resource name 只处理未 URL 编码 canonical name;百分号编码属于 transport。
16
+
17
+ ## 验证
18
+
19
+ 在 `servora/` 执行:
20
+
21
+ ```bash
22
+ make web.typecheck
23
+ make web.build
24
+ ```
@@ -0,0 +1,206 @@
1
+ export class ResourceNameError extends Error {
2
+ override readonly name = "ResourceNameError";
3
+
4
+ constructor(message: string) {
5
+ super(message);
6
+ }
7
+ }
8
+
9
+ export type FieldCollection =
10
+ | readonly string[]
11
+ | Readonly<Record<string, string>>;
12
+
13
+ export type FieldOf<Fields extends FieldCollection> = Fields extends readonly (
14
+ infer Field extends string
15
+ )[]
16
+ ? Field
17
+ : Fields extends Readonly<Record<string, infer Field extends string>>
18
+ ? Field
19
+ : never;
20
+
21
+ export type FieldKeyOf<Fields extends FieldCollection> =
22
+ Fields extends readonly (infer Field extends string)[]
23
+ ? Field
24
+ : Fields extends Readonly<Record<infer Key extends string, string>>
25
+ ? Key
26
+ : never;
27
+
28
+ function fieldEntries(fields: FieldCollection): ReadonlyArray<readonly [string, string]> {
29
+ return Array.isArray(fields)
30
+ ? fields.map((field) => [field, field] as const)
31
+ : Object.entries(fields as Readonly<Record<string, string>>);
32
+ }
33
+
34
+ function fieldValues(fields: FieldCollection): readonly string[] {
35
+ return fieldEntries(fields).map(([, path]) => path);
36
+ }
37
+
38
+ function allowedFields(fields: FieldCollection): ReadonlySet<string> {
39
+ return new Set(fieldValues(fields));
40
+ }
41
+
42
+ /**
43
+ * Builds a comma-separated Proto FieldMask from fields present on values.
44
+ * Presence is based on own keys, so an explicit `undefined` still selects a
45
+ * field and can represent a Clear intent at the caller boundary.
46
+ */
47
+ export function makeUpdateMask<
48
+ const Fields extends FieldCollection,
49
+ Values extends Partial<Record<FieldKeyOf<Fields>, unknown>>,
50
+ >(fields: Fields, values: Values): string {
51
+ const entries = fieldEntries(fields);
52
+ const allowedKeys = new Set(entries.map(([key]) => key));
53
+ const selected = new Set(Object.keys(values));
54
+ const unknown = [...selected].filter((field) => !allowedKeys.has(field));
55
+ if (unknown.length > 0) {
56
+ throw new RangeError(`unknown update field: ${unknown.join(", ")}`);
57
+ }
58
+ return entries
59
+ .filter(([key]) => selected.has(key))
60
+ .map(([, path]) => path)
61
+ .join(",");
62
+ }
63
+
64
+ export type FilterOperator = "=" | "!=" | "<" | "<=" | ">" | ">=" | ":";
65
+
66
+ const rawFilterValueSymbol: unique symbol = Symbol("RawFilterValue");
67
+
68
+ export type RawFilterValue = Readonly<{
69
+ [rawFilterValueSymbol]: true;
70
+ text: string;
71
+ }>;
72
+
73
+ /** Use for validated enum symbols or AIP functions such as duration("5s"). */
74
+ export function rawFilterValue(text: string): RawFilterValue {
75
+ if (text.length === 0) {
76
+ throw new RangeError("raw filter value must not be empty");
77
+ }
78
+ return Object.freeze({ [rawFilterValueSymbol]: true as const, text });
79
+ }
80
+
81
+ export type FilterValue =
82
+ | string
83
+ | number
84
+ | bigint
85
+ | boolean
86
+ | Date
87
+ | null
88
+ | RawFilterValue;
89
+
90
+ export type FilterExpression<Field extends string> =
91
+ | Readonly<{
92
+ field: Field;
93
+ operator: FilterOperator;
94
+ value: FilterValue;
95
+ }>
96
+ | Readonly<{ and: readonly FilterExpression<Field>[] }>
97
+ | Readonly<{ or: readonly FilterExpression<Field>[] }>;
98
+
99
+ /** Serializes a typed expression into the AIP-160 filter text accepted by CRUD. */
100
+ export function buildFilter<const Fields extends FieldCollection>(
101
+ fields: Fields,
102
+ expression?: FilterExpression<FieldOf<Fields>> | null,
103
+ ): string | undefined {
104
+ if (expression == null) return undefined;
105
+ return renderFilter(expression, allowedFields(fields));
106
+ }
107
+
108
+ function renderFilter(
109
+ expression: FilterExpression<string>,
110
+ fields: ReadonlySet<string>,
111
+ ): string {
112
+ if ("field" in expression) {
113
+ if (!fields.has(expression.field)) {
114
+ throw new RangeError(`unknown filter field: ${expression.field}`);
115
+ }
116
+ if (expression.value === null && !["=", "!="].includes(expression.operator)) {
117
+ throw new RangeError("null filter values only support = and !=");
118
+ }
119
+ return `${expression.field} ${expression.operator} ${renderFilterValue(expression.value)}`;
120
+ }
121
+ const [operator, children] = "and" in expression
122
+ ? (["AND", expression.and] as const)
123
+ : (["OR", expression.or] as const);
124
+ if (children.length === 0) {
125
+ throw new RangeError(`${operator} filter group must not be empty`);
126
+ }
127
+ return `(${children.map((child) => renderFilter(child, fields)).join(` ${operator} `)})`;
128
+ }
129
+
130
+ function renderFilterValue(value: FilterValue): string {
131
+ if (value === null) return "null";
132
+ if (typeof value === "string") return JSON.stringify(value);
133
+ if (typeof value === "boolean" || typeof value === "bigint") {
134
+ return value.toString();
135
+ }
136
+ if (typeof value === "number") {
137
+ if (!Number.isFinite(value)) {
138
+ throw new RangeError("filter numbers must be finite");
139
+ }
140
+ return value.toString();
141
+ }
142
+ if (value instanceof Date) {
143
+ if (Number.isNaN(value.getTime())) {
144
+ throw new RangeError("filter date must be valid");
145
+ }
146
+ return `timestamp(${JSON.stringify(value.toISOString())})`;
147
+ }
148
+ return value.text;
149
+ }
150
+
151
+ export type OrderDirection = "asc" | "desc";
152
+
153
+ export type OrderTerm<Field extends string> = Readonly<{
154
+ field: Field;
155
+ direction?: OrderDirection;
156
+ }>;
157
+
158
+ /** Serializes typed terms into canonical AIP-132 order_by text. */
159
+ export function buildOrderBy<const Fields extends FieldCollection>(
160
+ fields: Fields,
161
+ terms?: readonly OrderTerm<FieldOf<Fields>>[] | null,
162
+ ): string | undefined {
163
+ if (terms == null || terms.length === 0) return undefined;
164
+ const allowed = allowedFields(fields);
165
+ const seen = new Set<string>();
166
+ return terms
167
+ .map(({ field, direction = "asc" }) => {
168
+ if (!allowed.has(field)) {
169
+ throw new RangeError(`unknown order field: ${field}`);
170
+ }
171
+ if (seen.has(field)) {
172
+ throw new RangeError(`duplicate order field: ${field}`);
173
+ }
174
+ seen.add(field);
175
+ return direction === "desc" ? `${field} desc` : field;
176
+ })
177
+ .join(",");
178
+ }
179
+
180
+ export type Pager = Readonly<{
181
+ pageToken?: string;
182
+ exhausted: boolean;
183
+ }>;
184
+
185
+ export const firstPage: Pager = Object.freeze({ exhausted: false });
186
+
187
+ /** Returns the state for the response's next page without mutating prior state. */
188
+ export function advancePager(nextPageToken?: string | null): Pager {
189
+ return nextPageToken
190
+ ? Object.freeze({ pageToken: nextPageToken, exhausted: false })
191
+ : Object.freeze({ exhausted: true });
192
+ }
193
+
194
+ /** Applies the current token to a cloned request object. */
195
+ export function applyPager<Request extends Readonly<Record<string, unknown>>>(
196
+ pager: Pager,
197
+ request: Request,
198
+ ): Request & { pageToken?: string } {
199
+ const next = { ...request } as Request & { pageToken?: string };
200
+ if (pager.pageToken === undefined) {
201
+ delete next.pageToken;
202
+ } else {
203
+ next.pageToken = pager.pageToken;
204
+ }
205
+ return next;
206
+ }
@@ -1,63 +1,59 @@
1
1
  // Code generated by protoc-gen-typescript-http. DO NOT EDIT.
2
- /* eslint-disable camelcase */
3
- // @ts-nocheck
2
+ /* eslint-disable no-use-before-define, @typescript-eslint/no-unused-vars, prettier/prettier */
4
3
 
5
- // AuditMode 表达审计开关三态。
6
- // 引入「服务级默认 + 方法级覆盖」机制后,proto3 bool 默认值与「未指定」无法区分;
7
- // 用 enum 三态可让方法级显式继承(UNSPECIFIED)/ 显式覆盖(DISABLED/ENABLED)语义清晰。
8
- // 迁移说明:从 v0.x 起替代原 `bool enabled` 字段;旧写法 `enabled: true` 迁移为
9
- // `mode: AUDIT_MODE_ENABLED`,`enabled: false` 迁移为 `mode: AUDIT_MODE_DISABLED`,
10
- // 未指定保留为 `AUDIT_MODE_UNSPECIFIED` 表示继承服务级默认。
11
- export type AuditMode =
12
- | "AUDIT_MODE_UNSPECIFIED"
13
- | "AUDIT_MODE_DISABLED"
14
- | "AUDIT_MODE_ENABLED";
15
- // ExtensionMapping 将一个 CloudEvents 扩展属性映射到请求/响应字段或字面值。
16
- // 用于在注解中声明运行时需要从请求/响应消息中提取哪些值作为事件扩展属性。
17
- export type ExtensionMapping = {
18
- // CloudEvents 扩展属性名称(如 "mutation"、"resourcetype")。
19
- name: string | undefined;
20
- // 从请求/响应消息的 proto field path 提取(如 "req.id"、"resp.name")。
21
- fromField?: string;
22
- // 字面值,直接写入事件扩展属性。
23
- literal?: servoracloudeventsv1_CloudEvent_CloudEventAttributeValue;
24
- };
4
+ interface TransportMeta {
5
+ service: string;
6
+ method: string;
7
+ }
25
8
 
26
- // The CloudEvent specification defines seven attribute value types.
27
- export type servoracloudeventsv1_CloudEvent_CloudEventAttributeValue = {
28
- ceBoolean?: boolean;
29
- ceInteger?: number;
30
- ceString?: string;
31
- ceBytes?: string;
32
- ceUri?: string;
33
- ceUriRef?: string;
34
- ceTimestamp?: wellKnownTimestamp;
35
- };
9
+ export interface ClientTransport {
10
+ unary<T>(
11
+ path: string,
12
+ method: string,
13
+ body: null | string,
14
+ meta: TransportMeta,
15
+ ): Promise<T>;
16
+ serverStream<T>(path: string, meta: TransportMeta): ServerStream<T>;
17
+ duplexStream<TIn, TOut>(path: string, meta: TransportMeta): DuplexStream<TIn, TOut>;
18
+ }
19
+
20
+ export interface ServerStream<T> {
21
+ onEvent(listener: (data: T) => void): () => void;
22
+ onError(handler: (error: Error) => void): void;
23
+ close(): void;
24
+ }
36
25
 
37
- // Encoded using RFC 3339, where generated output will always be Z-normalized
38
- // and uses 0, 3, 6 or 9 fractional digits.
39
- // Offsets other than "Z" are also accepted.
40
- type wellKnownTimestamp = string;
26
+ export interface DuplexStream<TIn, TOut> extends ServerStream<TOut> {
27
+ send(data: TIn): void;
28
+ }
41
29
 
42
- // AuditRule 声明一个 RPC 方法的审计规则。
43
- // 与 CloudEvents 对齐:event_type 和 severity 映射到 CloudEvents type 与扩展属性,
44
- // extensions 允许声明式地从请求/响应中提取任意扩展属性。
30
+ function encodePathSegment(value: unknown): string {
31
+ return encodeURIComponent(String(value)).replace(/[!'()*]/g, (character) => `%${character.charCodeAt(0).toString(16).toUpperCase()}`);
32
+ }
33
+
34
+ function encodeMultiSegmentPath(value: unknown): string {
35
+ return String(value)
36
+ .split('/')
37
+ .map(encodePathSegment)
38
+ .join('/');
39
+ }
40
+
41
+ // AuditMode controls whether an RPC operation produces a runtime audit event.
42
+ export type AuditMode =
43
+ // DISABLED suppresses audit events for this operation.
44
+ | 'AUDIT_MODE_DISABLED'
45
+ // ENABLED emits a servora.audit.rpc.v1 CloudEvents event for every call.
46
+ | 'AUDIT_MODE_ENABLED'
47
+ // UNSPECIFIED inherits the service-level default; treated as DISABLED if no
48
+ // service default is declared.
49
+ | 'AUDIT_MODE_UNSPECIFIED';
50
+ // AuditRule is the RPC audit on/off switch. It intentionally carries only
51
+ // mode: event type, severity, field extraction and CloudEvents extensions are
52
+ // the responsibility of the event producer (authn, authz, CRUD generator, or
53
+ // business code). Keeping this annotation minimal prevents it from becoming a
54
+ // mixed DSL.
45
55
  export type AuditRule = {
46
- // 是否产生审计事件。UNSPECIFIED 表示沿用服务级默认或框架默认。
47
- mode: AuditMode | undefined;
48
- // CloudEvents type 属性值(如 "servora.audit.resource_mutation")。
49
- eventType: string | undefined;
50
- // 事件严重级别(如 "info"、"warning"、"critical")。
51
- // 映射到 CloudEvents 扩展属性 "severity"。
52
- severity: string | undefined;
53
- // detail message 的 proto field path(如 "req"),
54
- // 运行时序列化后作为 CloudEvent data 载荷。留空则不附带详情。
55
- detailMessageField: string | undefined;
56
- // 目标 ID 的 proto field path(如 "req.id"、"resp.id")。
57
- // 由 protoc-gen-servora-audit 生成提取函数,留空则不提取。
58
- targetIdField: string | undefined;
59
- // 额外的 CloudEvents 扩展属性映射。
60
- extensions: ExtensionMapping[] | undefined;
56
+ mode?: AuditMode;
61
57
  };
62
58
 
63
59
 
@@ -0,0 +1,78 @@
1
+ // Code generated by protoc-gen-typescript-http. DO NOT EDIT.
2
+ /* eslint-disable no-use-before-define, @typescript-eslint/no-unused-vars, prettier/prettier */
3
+
4
+ interface TransportMeta {
5
+ service: string;
6
+ method: string;
7
+ }
8
+
9
+ export interface ClientTransport {
10
+ unary<T>(
11
+ path: string,
12
+ method: string,
13
+ body: null | string,
14
+ meta: TransportMeta,
15
+ ): Promise<T>;
16
+ serverStream<T>(path: string, meta: TransportMeta): ServerStream<T>;
17
+ duplexStream<TIn, TOut>(path: string, meta: TransportMeta): DuplexStream<TIn, TOut>;
18
+ }
19
+
20
+ export interface ServerStream<T> {
21
+ onEvent(listener: (data: T) => void): () => void;
22
+ onError(handler: (error: Error) => void): void;
23
+ close(): void;
24
+ }
25
+
26
+ export interface DuplexStream<TIn, TOut> extends ServerStream<TOut> {
27
+ send(data: TIn): void;
28
+ }
29
+
30
+ function encodePathSegment(value: unknown): string {
31
+ return encodeURIComponent(String(value)).replace(/[!'()*]/g, (character) => `%${character.charCodeAt(0).toString(16).toUpperCase()}`);
32
+ }
33
+
34
+ function encodeMultiSegmentPath(value: unknown): string {
35
+ return String(value)
36
+ .split('/')
37
+ .map(encodePathSegment)
38
+ .join('/');
39
+ }
40
+
41
+ // AuthnFailure is the CloudEvents data payload for servora.authn.failure.v1
42
+ // events. All string fields MUST be sanitised — no raw tokens, API keys, or
43
+ // full JWT claims may appear here.
44
+ export type AuthnFailure = {
45
+ // attempts lists the per-scheme authentication results when Multi dispatch
46
+ // was used.
47
+ attempts?: SchemeAttempt[];
48
+ // code is the HTTP/gRPC status code (e.g. 401).
49
+ code?: number;
50
+ // message is a sanitised, human-readable failure description.
51
+ message?: string;
52
+ // reason is the high-level failure reason (e.g. "AUTHN_FAILED").
53
+ reason?: string;
54
+ };
55
+
56
+ // SchemeAttempt records the outcome of a single authentication scheme within a
57
+ // Multi-dispatcher round.
58
+ export type SchemeAttempt = {
59
+ // message is a sanitised description from this scheme's backend.
60
+ message?: string;
61
+ // reason is the sanitised failure reason returned by this scheme's backend.
62
+ reason?: string;
63
+ // scheme is the authenticator name (e.g. "jwt", "apikey", "casdoor").
64
+ scheme?: string;
65
+ };
66
+
67
+ // AuthnSuccess is the CloudEvents data payload for servora.authn.success.v1
68
+ // events. Identity fields are intentionally omitted — the authenticated
69
+ // subject is carried in CloudEvents extensions or set by the business layer.
70
+ export type AuthnSuccess = {
71
+ // message is an optional human-readable note.
72
+ message?: string;
73
+ // scheme is the authentication scheme that succeeded (e.g. "jwt", "apikey").
74
+ scheme?: string;
75
+ };
76
+
77
+
78
+ // @@protoc_insertion_point(typescript-http-eof)
@@ -1,25 +1,61 @@
1
1
  // Code generated by protoc-gen-typescript-http. DO NOT EDIT.
2
- /* eslint-disable camelcase */
3
- // @ts-nocheck
2
+ /* eslint-disable no-use-before-define, @typescript-eslint/no-unused-vars, prettier/prettier */
3
+
4
+ interface TransportMeta {
5
+ service: string;
6
+ method: string;
7
+ }
8
+
9
+ export interface ClientTransport {
10
+ unary<T>(
11
+ path: string,
12
+ method: string,
13
+ body: null | string,
14
+ meta: TransportMeta,
15
+ ): Promise<T>;
16
+ serverStream<T>(path: string, meta: TransportMeta): ServerStream<T>;
17
+ duplexStream<TIn, TOut>(path: string, meta: TransportMeta): DuplexStream<TIn, TOut>;
18
+ }
19
+
20
+ export interface ServerStream<T> {
21
+ onEvent(listener: (data: T) => void): () => void;
22
+ onError(handler: (error: Error) => void): void;
23
+ close(): void;
24
+ }
25
+
26
+ export interface DuplexStream<TIn, TOut> extends ServerStream<TOut> {
27
+ send(data: TIn): void;
28
+ }
29
+
30
+ function encodePathSegment(value: unknown): string {
31
+ return encodeURIComponent(String(value)).replace(/[!'()*]/g, (character) => `%${character.charCodeAt(0).toString(16).toUpperCase()}`);
32
+ }
33
+
34
+ function encodeMultiSegmentPath(value: unknown): string {
35
+ return String(value)
36
+ .split('/')
37
+ .map(encodePathSegment)
38
+ .join('/');
39
+ }
4
40
 
5
41
  // AuthnRule 声明 RPC 方法的认证策略。
6
42
  export type AuthnRule = {
7
43
  // 认证模式。
8
- mode: AuthnRule_Mode | undefined;
44
+ mode?: AuthnRule_Mode;
9
45
  // 接受的认证机制;空列表表示沿用框架默认引擎。
10
46
  // 取值是各 wrapper 子包持有的私有 method 字符串常量(如 `jwt`、`mtls`、`api_key`、`aksk`);
11
47
  // framework 不枚举这些值,业务自定义引擎也可填任意字符串。
12
48
  // 多个值表示"任一通过即可"。
13
- schemes: string[] | undefined;
49
+ schemes?: string[];
14
50
  };
15
51
 
16
52
  // Mode 表达认证模式三态。
17
53
  export type AuthnRule_Mode =
18
- // 未指定,等价"未写注解":私有 + 框架默认引擎(fail-closed 默认)。
19
- | "MODE_UNSPECIFIED"
20
54
  // 显式公开。schemes 必须为空。
21
- | "MODE_PUBLIC"
55
+ | 'MODE_PUBLIC'
22
56
  // 必须用 schemes 指定的认证机制。schemes 必须非空。
23
- | "MODE_REQUIRED";
57
+ | 'MODE_REQUIRED'
58
+ // 未指定,等价"未写注解":私有 + 框架默认引擎(fail-closed 默认)。
59
+ | 'MODE_UNSPECIFIED';
24
60
 
25
61
  // @@protoc_insertion_point(typescript-http-eof)
@@ -0,0 +1,76 @@
1
+ // Code generated by protoc-gen-typescript-http. DO NOT EDIT.
2
+ /* eslint-disable no-use-before-define, @typescript-eslint/no-unused-vars, prettier/prettier */
3
+
4
+ interface TransportMeta {
5
+ service: string;
6
+ method: string;
7
+ }
8
+
9
+ export interface ClientTransport {
10
+ unary<T>(
11
+ path: string,
12
+ method: string,
13
+ body: null | string,
14
+ meta: TransportMeta,
15
+ ): Promise<T>;
16
+ serverStream<T>(path: string, meta: TransportMeta): ServerStream<T>;
17
+ duplexStream<TIn, TOut>(path: string, meta: TransportMeta): DuplexStream<TIn, TOut>;
18
+ }
19
+
20
+ export interface ServerStream<T> {
21
+ onEvent(listener: (data: T) => void): () => void;
22
+ onError(handler: (error: Error) => void): void;
23
+ close(): void;
24
+ }
25
+
26
+ export interface DuplexStream<TIn, TOut> extends ServerStream<TOut> {
27
+ send(data: TIn): void;
28
+ }
29
+
30
+ function encodePathSegment(value: unknown): string {
31
+ return encodeURIComponent(String(value)).replace(/[!'()*]/g, (character) => `%${character.charCodeAt(0).toString(16).toUpperCase()}`);
32
+ }
33
+
34
+ function encodeMultiSegmentPath(value: unknown): string {
35
+ return String(value)
36
+ .split('/')
37
+ .map(encodePathSegment)
38
+ .join('/');
39
+ }
40
+
41
+ // AuthzDecision is the CloudEvents data payload shared by all three authz
42
+ // audit event types:
43
+ // - servora.authz.allowed.v1
44
+ // - servora.authz.denied.v1
45
+ // - servora.authz.error.v1
46
+ // The Decision enum distinguishes outcomes so consumers can branch on data
47
+ // without re-parsing the CloudEvents type attribute.
48
+ export type AuthzDecision = {
49
+ // action is the authz action being checked (e.g. "read", "delete").
50
+ action?: string;
51
+ // backend identifies the authorizer implementation (e.g. "openfga", "casbin").
52
+ backend?: string;
53
+ // code is the HTTP/gRPC status code.
54
+ code?: number;
55
+ decision?: AuthzDecision_Decision;
56
+ // message is a sanitised description.
57
+ message?: string;
58
+ // reason is an optional Kratos-style reason code (e.g. "AUTHZ_DENIED").
59
+ reason?: string;
60
+ // resource_id is the resolved resource identifier.
61
+ resourceId?: string;
62
+ // resource_type is the resource type from the authz rule (e.g. "document").
63
+ resourceType?: string;
64
+ };
65
+
66
+ // Decision enumerates the three possible authz outcomes.
67
+ export type AuthzDecision_Decision =
68
+ // ALLOWED — authorizer.Check returned (true, nil).
69
+ | 'DECISION_ALLOWED'
70
+ // DENIED — authorizer.Check returned (false, nil): policy explicitly denied.
71
+ | 'DECISION_DENIED'
72
+ // ERROR — authorizer.Check returned (_, err != nil): check itself failed.
73
+ | 'DECISION_ERROR'
74
+ | 'DECISION_UNSPECIFIED';
75
+
76
+ // @@protoc_insertion_point(typescript-http-eof)