@bearei/contracts 3.3.0 → 3.4.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.
Files changed (8) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/README.md +1 -0
  3. package/README.zh-CN.md +1 -0
  4. package/dist/index.d.mts +13 -2
  5. package/dist/index.d.ts +13 -2
  6. package/dist/index.js +12 -0
  7. package/dist/index.mjs +11 -0
  8. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -4,6 +4,15 @@ 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.4.0 — 2026-11-05
8
+
9
+ ### Added
10
+
11
+ - `PAYMENT_TRANSACTION_STATE` and `PaymentTransactionState`: the transaction states stored and
12
+ returned by `bearei-pay`. The values (`ACTIVE`, `EXPIRED`, `GRACE`, `REFUNDED`, `REVOKED`) were
13
+ previously declared inside the service; they now live in the shared contract so clients can type
14
+ `state` without copying the list. The release is additive and no existing export changed.
15
+
7
16
  ## 3.3.0 — 2026-11-05
8
17
 
9
18
  ### Added
package/README.md CHANGED
@@ -16,6 +16,7 @@ English | [中文](./README.zh-CN.md)
16
16
  | `EMAIL_TEMPLATE`, `EmailTemplate` | value | Email template values used by services and clients |
17
17
  | `ORDER`, `Order` | value | Sort order values |
18
18
  | `PAYMENT_CHANNEL`, `PAYMENT_ENVIRONMENT`, `PAYMENT_EVENT_TYPE` | value | Payment contract vocabulary shared by services |
19
+ | `PAYMENT_TRANSACTION_STATE`, `PaymentTransactionState` | value | Transaction states returned by the payment service |
19
20
  | `PERMISSION`, `Permission`, `ALL_PERMISSION_KEY` | value | Permission values and the administrator sentinel |
20
21
  | `SUBSCRIPTION_FEATURE`, `SubscriptionFeature` | value | Subscription feature values scoped like permissions |
21
22
 
package/README.zh-CN.md CHANGED
@@ -16,6 +16,7 @@ ESM 与 CommonJS 两种产物。
16
16
  | `EMAIL_TEMPLATE`、`EmailTemplate` | 值 | 服务与客户端共用的邮件模板值 |
17
17
  | `ORDER`、`Order` | 值 | 排序值 |
18
18
  | `PAYMENT_CHANNEL`、`PAYMENT_ENVIRONMENT`、`PAYMENT_EVENT_TYPE` | 值 | 支付服务与订阅服务共用的支付契约词表 |
19
+ | `PAYMENT_TRANSACTION_STATE`、`PaymentTransactionState` | 值 | 支付服务返回的交易状态值 |
19
20
  | `PERMISSION`、`Permission`、`ALL_PERMISSION_KEY` | 值 | 服务与客户端共用的权限值与管理员哨兵值 |
20
21
  | `SUBSCRIPTION_FEATURE`、`SubscriptionFeature` | 值 | 订阅特性值，与权限使用相同的区域写法 |
21
22
 
package/dist/index.d.mts CHANGED
@@ -33,13 +33,16 @@ declare const HTTP_EXCEPTION_CODE: {
33
33
  readonly MISSING_SUBSCRIPTION_USER_ENTITY: 400010;
34
34
  readonly NOT_FOUND: 404000;
35
35
  readonly NOT_SUBSCRIBED: 403002;
36
+ /** Reserved: a 1.0-era code; no 2.0 service produces it. Never reuse or renumber. */
36
37
  readonly OR_VALIDATION_PARAMETER_INVALID: 400002;
37
38
  readonly PASSWORD_HAS_EXPIRED: 401006;
38
39
  readonly PASSWORD_IS_INVALID: 401007;
39
40
  readonly PROHIBITED_OPERATIONS: 403001;
40
41
  readonly PROHIBITED_RESET_PASSWORD: 403003;
42
+ /** Default when `REQUEST_TIMEOUT` is thrown without a code; services should pass 408001. */
41
43
  readonly REQUEST_TIMEOUT: 408000;
42
44
  readonly SERVICE_FIELDS_ALREADY_EXISTS: 400003;
45
+ /** Reserved: a 1.0-era code; no 2.0 service produces it. Never reuse or renumber. */
43
46
  readonly SIGNATURE_STRING_LENGTH_LIMIT: 400004;
44
47
  readonly TOKEN_IS_NOT_FOUND: 401001;
45
48
  readonly UNAUTHORIZED: 401000;
@@ -125,6 +128,14 @@ declare const PAYMENT_EVENT_TYPE: {
125
128
  readonly SUBSCRIBED: "SUBSCRIBED";
126
129
  };
127
130
  type PaymentEventType = (typeof PAYMENT_EVENT_TYPE)[keyof typeof PAYMENT_EVENT_TYPE];
131
+ declare const PAYMENT_TRANSACTION_STATE: {
132
+ readonly ACTIVE: "ACTIVE";
133
+ readonly EXPIRED: "EXPIRED";
134
+ readonly GRACE: "GRACE";
135
+ readonly REFUNDED: "REFUNDED";
136
+ readonly REVOKED: "REVOKED";
137
+ };
138
+ type PaymentTransactionState = (typeof PAYMENT_TRANSACTION_STATE)[keyof typeof PAYMENT_TRANSACTION_STATE];
128
139
 
129
140
  declare const PERMISSION: {
130
141
  readonly ACTION_LOG_CREATE: "action-log:create";
@@ -207,5 +218,5 @@ declare const SUBSCRIPTION_FEATURE: {
207
218
  };
208
219
  type SubscriptionFeature = (typeof SUBSCRIPTION_FEATURE)[keyof typeof SUBSCRIPTION_FEATURE];
209
220
 
210
- export { ALL_PERMISSION_KEY, DEFAULT_PAGE_SIZE, EMAIL_TEMPLATE, HTTP_EXCEPTION_CODE, LANGUAGE, MAX_PAGE_SIZE, ORDER, PAYMENT_CHANNEL, PAYMENT_ENVIRONMENT, PAYMENT_EVENT_TYPE, PERMISSION, RESERVED_REQUEST_HEADER, SUBSCRIPTION_FEATURE };
211
- export type { ApiErrorBody, ApiErrorResponseBody, ApiValidationErrorBody, EmailTemplate, HttpExceptionCode, Language, Order, PaginatedResult, PaginationQuery, PaymentChannel, PaymentEnvironment, PaymentEventType, Permission, ReservedRequestHeaderName, SubscriptionFeature };
221
+ export { ALL_PERMISSION_KEY, DEFAULT_PAGE_SIZE, EMAIL_TEMPLATE, HTTP_EXCEPTION_CODE, LANGUAGE, MAX_PAGE_SIZE, ORDER, PAYMENT_CHANNEL, PAYMENT_ENVIRONMENT, PAYMENT_EVENT_TYPE, PAYMENT_TRANSACTION_STATE, PERMISSION, RESERVED_REQUEST_HEADER, SUBSCRIPTION_FEATURE };
222
+ export type { ApiErrorBody, ApiErrorResponseBody, ApiValidationErrorBody, EmailTemplate, HttpExceptionCode, Language, Order, PaginatedResult, PaginationQuery, PaymentChannel, PaymentEnvironment, PaymentEventType, PaymentTransactionState, Permission, ReservedRequestHeaderName, SubscriptionFeature };
package/dist/index.d.ts CHANGED
@@ -33,13 +33,16 @@ declare const HTTP_EXCEPTION_CODE: {
33
33
  readonly MISSING_SUBSCRIPTION_USER_ENTITY: 400010;
34
34
  readonly NOT_FOUND: 404000;
35
35
  readonly NOT_SUBSCRIBED: 403002;
36
+ /** Reserved: a 1.0-era code; no 2.0 service produces it. Never reuse or renumber. */
36
37
  readonly OR_VALIDATION_PARAMETER_INVALID: 400002;
37
38
  readonly PASSWORD_HAS_EXPIRED: 401006;
38
39
  readonly PASSWORD_IS_INVALID: 401007;
39
40
  readonly PROHIBITED_OPERATIONS: 403001;
40
41
  readonly PROHIBITED_RESET_PASSWORD: 403003;
42
+ /** Default when `REQUEST_TIMEOUT` is thrown without a code; services should pass 408001. */
41
43
  readonly REQUEST_TIMEOUT: 408000;
42
44
  readonly SERVICE_FIELDS_ALREADY_EXISTS: 400003;
45
+ /** Reserved: a 1.0-era code; no 2.0 service produces it. Never reuse or renumber. */
43
46
  readonly SIGNATURE_STRING_LENGTH_LIMIT: 400004;
44
47
  readonly TOKEN_IS_NOT_FOUND: 401001;
45
48
  readonly UNAUTHORIZED: 401000;
@@ -125,6 +128,14 @@ declare const PAYMENT_EVENT_TYPE: {
125
128
  readonly SUBSCRIBED: "SUBSCRIBED";
126
129
  };
127
130
  type PaymentEventType = (typeof PAYMENT_EVENT_TYPE)[keyof typeof PAYMENT_EVENT_TYPE];
131
+ declare const PAYMENT_TRANSACTION_STATE: {
132
+ readonly ACTIVE: "ACTIVE";
133
+ readonly EXPIRED: "EXPIRED";
134
+ readonly GRACE: "GRACE";
135
+ readonly REFUNDED: "REFUNDED";
136
+ readonly REVOKED: "REVOKED";
137
+ };
138
+ type PaymentTransactionState = (typeof PAYMENT_TRANSACTION_STATE)[keyof typeof PAYMENT_TRANSACTION_STATE];
128
139
 
129
140
  declare const PERMISSION: {
130
141
  readonly ACTION_LOG_CREATE: "action-log:create";
@@ -207,5 +218,5 @@ declare const SUBSCRIPTION_FEATURE: {
207
218
  };
208
219
  type SubscriptionFeature = (typeof SUBSCRIPTION_FEATURE)[keyof typeof SUBSCRIPTION_FEATURE];
209
220
 
210
- export { ALL_PERMISSION_KEY, DEFAULT_PAGE_SIZE, EMAIL_TEMPLATE, HTTP_EXCEPTION_CODE, LANGUAGE, MAX_PAGE_SIZE, ORDER, PAYMENT_CHANNEL, PAYMENT_ENVIRONMENT, PAYMENT_EVENT_TYPE, PERMISSION, RESERVED_REQUEST_HEADER, SUBSCRIPTION_FEATURE };
211
- export type { ApiErrorBody, ApiErrorResponseBody, ApiValidationErrorBody, EmailTemplate, HttpExceptionCode, Language, Order, PaginatedResult, PaginationQuery, PaymentChannel, PaymentEnvironment, PaymentEventType, Permission, ReservedRequestHeaderName, SubscriptionFeature };
221
+ export { ALL_PERMISSION_KEY, DEFAULT_PAGE_SIZE, EMAIL_TEMPLATE, HTTP_EXCEPTION_CODE, LANGUAGE, MAX_PAGE_SIZE, ORDER, PAYMENT_CHANNEL, PAYMENT_ENVIRONMENT, PAYMENT_EVENT_TYPE, PAYMENT_TRANSACTION_STATE, PERMISSION, RESERVED_REQUEST_HEADER, SUBSCRIPTION_FEATURE };
222
+ export type { ApiErrorBody, ApiErrorResponseBody, ApiValidationErrorBody, EmailTemplate, HttpExceptionCode, Language, Order, PaginatedResult, PaginationQuery, PaymentChannel, PaymentEnvironment, PaymentEventType, PaymentTransactionState, Permission, ReservedRequestHeaderName, SubscriptionFeature };
package/dist/index.js CHANGED
@@ -30,6 +30,7 @@ __export(index_exports, {
30
30
  PAYMENT_CHANNEL: () => PAYMENT_CHANNEL,
31
31
  PAYMENT_ENVIRONMENT: () => PAYMENT_ENVIRONMENT,
32
32
  PAYMENT_EVENT_TYPE: () => PAYMENT_EVENT_TYPE,
33
+ PAYMENT_TRANSACTION_STATE: () => PAYMENT_TRANSACTION_STATE,
33
34
  PERMISSION: () => PERMISSION,
34
35
  RESERVED_REQUEST_HEADER: () => RESERVED_REQUEST_HEADER,
35
36
  SUBSCRIPTION_FEATURE: () => SUBSCRIPTION_FEATURE
@@ -68,13 +69,16 @@ var HTTP_EXCEPTION_CODE = {
68
69
  MISSING_SUBSCRIPTION_USER_ENTITY: 400010,
69
70
  NOT_FOUND: 404e3,
70
71
  NOT_SUBSCRIBED: 403002,
72
+ /** Reserved: a 1.0-era code; no 2.0 service produces it. Never reuse or renumber. */
71
73
  OR_VALIDATION_PARAMETER_INVALID: 400002,
72
74
  PASSWORD_HAS_EXPIRED: 401006,
73
75
  PASSWORD_IS_INVALID: 401007,
74
76
  PROHIBITED_OPERATIONS: 403001,
75
77
  PROHIBITED_RESET_PASSWORD: 403003,
78
+ /** Default when `REQUEST_TIMEOUT` is thrown without a code; services should pass 408001. */
76
79
  REQUEST_TIMEOUT: 408e3,
77
80
  SERVICE_FIELDS_ALREADY_EXISTS: 400003,
81
+ /** Reserved: a 1.0-era code; no 2.0 service produces it. Never reuse or renumber. */
78
82
  SIGNATURE_STRING_LENGTH_LIMIT: 400004,
79
83
  TOKEN_IS_NOT_FOUND: 401001,
80
84
  UNAUTHORIZED: 401e3,
@@ -126,6 +130,13 @@ var PAYMENT_EVENT_TYPE = {
126
130
  REVOKED: "REVOKED",
127
131
  SUBSCRIBED: "SUBSCRIBED"
128
132
  };
133
+ var PAYMENT_TRANSACTION_STATE = {
134
+ ACTIVE: "ACTIVE",
135
+ EXPIRED: "EXPIRED",
136
+ GRACE: "GRACE",
137
+ REFUNDED: "REFUNDED",
138
+ REVOKED: "REVOKED"
139
+ };
129
140
 
130
141
  // src/permission.enum.ts
131
142
  var PERMISSION = {
@@ -218,6 +229,7 @@ var SUBSCRIPTION_FEATURE = {
218
229
  PAYMENT_CHANNEL,
219
230
  PAYMENT_ENVIRONMENT,
220
231
  PAYMENT_EVENT_TYPE,
232
+ PAYMENT_TRANSACTION_STATE,
221
233
  PERMISSION,
222
234
  RESERVED_REQUEST_HEADER,
223
235
  SUBSCRIPTION_FEATURE
package/dist/index.mjs CHANGED
@@ -30,13 +30,16 @@ var HTTP_EXCEPTION_CODE = {
30
30
  MISSING_SUBSCRIPTION_USER_ENTITY: 400010,
31
31
  NOT_FOUND: 404e3,
32
32
  NOT_SUBSCRIBED: 403002,
33
+ /** Reserved: a 1.0-era code; no 2.0 service produces it. Never reuse or renumber. */
33
34
  OR_VALIDATION_PARAMETER_INVALID: 400002,
34
35
  PASSWORD_HAS_EXPIRED: 401006,
35
36
  PASSWORD_IS_INVALID: 401007,
36
37
  PROHIBITED_OPERATIONS: 403001,
37
38
  PROHIBITED_RESET_PASSWORD: 403003,
39
+ /** Default when `REQUEST_TIMEOUT` is thrown without a code; services should pass 408001. */
38
40
  REQUEST_TIMEOUT: 408e3,
39
41
  SERVICE_FIELDS_ALREADY_EXISTS: 400003,
42
+ /** Reserved: a 1.0-era code; no 2.0 service produces it. Never reuse or renumber. */
40
43
  SIGNATURE_STRING_LENGTH_LIMIT: 400004,
41
44
  TOKEN_IS_NOT_FOUND: 401001,
42
45
  UNAUTHORIZED: 401e3,
@@ -88,6 +91,13 @@ var PAYMENT_EVENT_TYPE = {
88
91
  REVOKED: "REVOKED",
89
92
  SUBSCRIBED: "SUBSCRIBED"
90
93
  };
94
+ var PAYMENT_TRANSACTION_STATE = {
95
+ ACTIVE: "ACTIVE",
96
+ EXPIRED: "EXPIRED",
97
+ GRACE: "GRACE",
98
+ REFUNDED: "REFUNDED",
99
+ REVOKED: "REVOKED"
100
+ };
91
101
 
92
102
  // src/permission.enum.ts
93
103
  var PERMISSION = {
@@ -179,6 +189,7 @@ export {
179
189
  PAYMENT_CHANNEL,
180
190
  PAYMENT_ENVIRONMENT,
181
191
  PAYMENT_EVENT_TYPE,
192
+ PAYMENT_TRANSACTION_STATE,
182
193
  PERMISSION,
183
194
  RESERVED_REQUEST_HEADER,
184
195
  SUBSCRIPTION_FEATURE
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bearei/contracts",
3
- "version": "3.3.0",
3
+ "version": "3.4.0",
4
4
  "description": "Framework-agnostic wire contracts shared by Bearei services, clients and apps",
5
5
  "keywords": [
6
6
  "bearei",