@bearei/contracts 3.0.0 → 3.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/README.md +1 -0
- package/README.zh-CN.md +1 -0
- package/dist/index.d.mts +8 -2
- package/dist/index.d.ts +8 -2
- package/dist/index.js +8 -0
- package/dist/index.mjs +7 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,14 @@ All notable changes to this project are documented in this file. The format is b
|
|
|
4
4
|
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to
|
|
5
5
|
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
6
6
|
|
|
7
|
+
## 3.1.0 — 2026-10-30
|
|
8
|
+
|
|
9
|
+
### Added
|
|
10
|
+
|
|
11
|
+
- `EMAIL_TEMPLATE` and `EmailTemplate`: the template identifiers accepted by `bearei-email` and used
|
|
12
|
+
by clients to pick an email template. Values are `SIGN_UP_CAPTCHA` and `RESET_PASSWORD_CAPTCHA`.
|
|
13
|
+
The enum is additive; no existing export changed.
|
|
14
|
+
|
|
7
15
|
## 3.0.0 — 2026-10-29
|
|
8
16
|
|
|
9
17
|
### Breaking
|
package/README.md
CHANGED
|
@@ -13,6 +13,7 @@ English | [中文](./README.zh-CN.md)
|
|
|
13
13
|
| `PaginationQuery`, `PaginatedResult<T>` | type | Paging request fields and page envelope |
|
|
14
14
|
| `RESERVED_REQUEST_HEADER`, `ReservedRequestHeaderName` | value | Headers set by the gateway or authentication layer |
|
|
15
15
|
| `LANGUAGE`, `Language` | value | Locale values |
|
|
16
|
+
| `EMAIL_TEMPLATE`, `EmailTemplate` | value | Email template values used by services and clients |
|
|
16
17
|
| `ORDER`, `Order` | value | Sort order values |
|
|
17
18
|
| `PERMISSION`, `Permission` | value | Permission values used by services and clients |
|
|
18
19
|
| `SUBSCRIPTION_FEATURE`, `SubscriptionFeature` | value | Subscription feature values scoped like permissions |
|
package/README.zh-CN.md
CHANGED
|
@@ -13,6 +13,7 @@ ESM 与 CommonJS 两种产物。
|
|
|
13
13
|
| `PaginationQuery`、`PaginatedResult<T>` | 类型 | 分页请求字段与分页响应信封 |
|
|
14
14
|
| `RESERVED_REQUEST_HEADER`、`ReservedRequestHeaderName` | 值 | 由网关或认证层写入的保留请求头 |
|
|
15
15
|
| `LANGUAGE`、`Language` | 值 | 语言值 |
|
|
16
|
+
| `EMAIL_TEMPLATE`、`EmailTemplate` | 值 | 服务与客户端共用的邮件模板值 |
|
|
16
17
|
| `ORDER`、`Order` | 值 | 排序值 |
|
|
17
18
|
| `PERMISSION`、`Permission` | 值 | 服务与客户端共用的权限值 |
|
|
18
19
|
| `SUBSCRIPTION_FEATURE`、`SubscriptionFeature` | 值 | 订阅特性值,与权限使用相同的区域写法 |
|
package/dist/index.d.mts
CHANGED
|
@@ -1,3 +1,9 @@
|
|
|
1
|
+
declare const EMAIL_TEMPLATE: {
|
|
2
|
+
readonly RESET_PASSWORD_CAPTCHA: "RESET_PASSWORD_CAPTCHA";
|
|
3
|
+
readonly SIGN_UP_CAPTCHA: "SIGN_UP_CAPTCHA";
|
|
4
|
+
};
|
|
5
|
+
type EmailTemplate = (typeof EMAIL_TEMPLATE)[keyof typeof EMAIL_TEMPLATE];
|
|
6
|
+
|
|
1
7
|
/**
|
|
2
8
|
* Numeric error codes shared by Bearei services and clients.
|
|
3
9
|
* Values are part of the wire contract: append new codes, never renumber or reuse.
|
|
@@ -166,5 +172,5 @@ declare const SUBSCRIPTION_FEATURE: {
|
|
|
166
172
|
};
|
|
167
173
|
type SubscriptionFeature = (typeof SUBSCRIPTION_FEATURE)[keyof typeof SUBSCRIPTION_FEATURE];
|
|
168
174
|
|
|
169
|
-
export { DEFAULT_PAGE_SIZE, HTTP_EXCEPTION_CODE, LANGUAGE, MAX_PAGE_SIZE, ORDER, PERMISSION, RESERVED_REQUEST_HEADER, SUBSCRIPTION_FEATURE };
|
|
170
|
-
export type { ApiErrorBody, HttpExceptionCode, Language, Order, PaginatedResult, PaginationQuery, Permission, ReservedRequestHeaderName, SubscriptionFeature };
|
|
175
|
+
export { DEFAULT_PAGE_SIZE, EMAIL_TEMPLATE, HTTP_EXCEPTION_CODE, LANGUAGE, MAX_PAGE_SIZE, ORDER, PERMISSION, RESERVED_REQUEST_HEADER, SUBSCRIPTION_FEATURE };
|
|
176
|
+
export type { ApiErrorBody, EmailTemplate, HttpExceptionCode, Language, Order, PaginatedResult, PaginationQuery, Permission, ReservedRequestHeaderName, SubscriptionFeature };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,3 +1,9 @@
|
|
|
1
|
+
declare const EMAIL_TEMPLATE: {
|
|
2
|
+
readonly RESET_PASSWORD_CAPTCHA: "RESET_PASSWORD_CAPTCHA";
|
|
3
|
+
readonly SIGN_UP_CAPTCHA: "SIGN_UP_CAPTCHA";
|
|
4
|
+
};
|
|
5
|
+
type EmailTemplate = (typeof EMAIL_TEMPLATE)[keyof typeof EMAIL_TEMPLATE];
|
|
6
|
+
|
|
1
7
|
/**
|
|
2
8
|
* Numeric error codes shared by Bearei services and clients.
|
|
3
9
|
* Values are part of the wire contract: append new codes, never renumber or reuse.
|
|
@@ -166,5 +172,5 @@ declare const SUBSCRIPTION_FEATURE: {
|
|
|
166
172
|
};
|
|
167
173
|
type SubscriptionFeature = (typeof SUBSCRIPTION_FEATURE)[keyof typeof SUBSCRIPTION_FEATURE];
|
|
168
174
|
|
|
169
|
-
export { DEFAULT_PAGE_SIZE, HTTP_EXCEPTION_CODE, LANGUAGE, MAX_PAGE_SIZE, ORDER, PERMISSION, RESERVED_REQUEST_HEADER, SUBSCRIPTION_FEATURE };
|
|
170
|
-
export type { ApiErrorBody, HttpExceptionCode, Language, Order, PaginatedResult, PaginationQuery, Permission, ReservedRequestHeaderName, SubscriptionFeature };
|
|
175
|
+
export { DEFAULT_PAGE_SIZE, EMAIL_TEMPLATE, HTTP_EXCEPTION_CODE, LANGUAGE, MAX_PAGE_SIZE, ORDER, PERMISSION, RESERVED_REQUEST_HEADER, SUBSCRIPTION_FEATURE };
|
|
176
|
+
export type { ApiErrorBody, EmailTemplate, HttpExceptionCode, Language, Order, PaginatedResult, PaginationQuery, Permission, ReservedRequestHeaderName, SubscriptionFeature };
|
package/dist/index.js
CHANGED
|
@@ -21,6 +21,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
|
|
|
21
21
|
var index_exports = {};
|
|
22
22
|
__export(index_exports, {
|
|
23
23
|
DEFAULT_PAGE_SIZE: () => DEFAULT_PAGE_SIZE,
|
|
24
|
+
EMAIL_TEMPLATE: () => EMAIL_TEMPLATE,
|
|
24
25
|
HTTP_EXCEPTION_CODE: () => HTTP_EXCEPTION_CODE,
|
|
25
26
|
LANGUAGE: () => LANGUAGE,
|
|
26
27
|
MAX_PAGE_SIZE: () => MAX_PAGE_SIZE,
|
|
@@ -31,6 +32,12 @@ __export(index_exports, {
|
|
|
31
32
|
});
|
|
32
33
|
module.exports = __toCommonJS(index_exports);
|
|
33
34
|
|
|
35
|
+
// src/email-template.enum.ts
|
|
36
|
+
var EMAIL_TEMPLATE = {
|
|
37
|
+
RESET_PASSWORD_CAPTCHA: "RESET_PASSWORD_CAPTCHA",
|
|
38
|
+
SIGN_UP_CAPTCHA: "SIGN_UP_CAPTCHA"
|
|
39
|
+
};
|
|
40
|
+
|
|
34
41
|
// src/error-code.enum.ts
|
|
35
42
|
var HTTP_EXCEPTION_CODE = {
|
|
36
43
|
ACCESS_DENIED_FOR_GUEST: 401003,
|
|
@@ -175,6 +182,7 @@ var SUBSCRIPTION_FEATURE = {
|
|
|
175
182
|
// Annotate the CommonJS export names for ESM import in node:
|
|
176
183
|
0 && (module.exports = {
|
|
177
184
|
DEFAULT_PAGE_SIZE,
|
|
185
|
+
EMAIL_TEMPLATE,
|
|
178
186
|
HTTP_EXCEPTION_CODE,
|
|
179
187
|
LANGUAGE,
|
|
180
188
|
MAX_PAGE_SIZE,
|
package/dist/index.mjs
CHANGED
|
@@ -1,3 +1,9 @@
|
|
|
1
|
+
// src/email-template.enum.ts
|
|
2
|
+
var EMAIL_TEMPLATE = {
|
|
3
|
+
RESET_PASSWORD_CAPTCHA: "RESET_PASSWORD_CAPTCHA",
|
|
4
|
+
SIGN_UP_CAPTCHA: "SIGN_UP_CAPTCHA"
|
|
5
|
+
};
|
|
6
|
+
|
|
1
7
|
// src/error-code.enum.ts
|
|
2
8
|
var HTTP_EXCEPTION_CODE = {
|
|
3
9
|
ACCESS_DENIED_FOR_GUEST: 401003,
|
|
@@ -141,6 +147,7 @@ var SUBSCRIPTION_FEATURE = {
|
|
|
141
147
|
};
|
|
142
148
|
export {
|
|
143
149
|
DEFAULT_PAGE_SIZE,
|
|
150
|
+
EMAIL_TEMPLATE,
|
|
144
151
|
HTTP_EXCEPTION_CODE,
|
|
145
152
|
LANGUAGE,
|
|
146
153
|
MAX_PAGE_SIZE,
|