npm - @bearei/contracts - Versions diffs - 3.0.0 → 3.2.0 - Mend

@bearei/contracts 3.0.0 → 3.2.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

package/CHANGELOG.md CHANGED Viewed

@@ -4,6 +4,23 @@ All notable changes to this project are documented in this file. The format is b
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+## 3.2.0 — 2026-10-30
+### Added
+- `PAYMENT_CHANNEL`, `PaymentChannel`, `PAYMENT_ENVIRONMENT`, `PaymentEnvironment`,
+  `PAYMENT_EVENT_TYPE` and `PaymentEventType`: the channel, environment and event vocabulary of the
+  frozen payment event contract between `bearei-pay` and `bearei-subscription`. Values match the
+  existing service enums; the release is additive and no existing export changed.
+## 3.1.0 — 2026-10-30
+### Added
+- `EMAIL_TEMPLATE` and `EmailTemplate`: the template identifiers accepted by `bearei-email` and used
+  by clients to pick an email template. Values are `SIGN_UP_CAPTCHA` and `RESET_PASSWORD_CAPTCHA`.
+  The enum is additive; no existing export changed.
 ## 3.0.0 — 2026-10-29
 ### Breaking

package/README.md CHANGED Viewed

@@ -5,17 +5,19 @@ runtime dependencies and ships both ESM and CommonJS builds.
 English | [中文](./README.zh-CN.md)
-| Export                                                 | Kind  | Purpose                                             |
-| ------------------------------------------------------ | ----- | --------------------------------------------------- |
-| `HTTP_EXCEPTION_CODE`, `HttpExceptionCode`             | value | Numeric error codes shared by services and clients  |
-| `ApiErrorBody`                                         | type  | Business error body `{code, message, statusCode}`   |
-| `DEFAULT_PAGE_SIZE`, `MAX_PAGE_SIZE`                   | value | Paging limits used by every list endpoint           |
-| `PaginationQuery`, `PaginatedResult<T>`                | type  | Paging request fields and page envelope             |
-| `RESERVED_REQUEST_HEADER`, `ReservedRequestHeaderName` | value | Headers set by the gateway or authentication layer  |
-| `LANGUAGE`, `Language`                                 | value | Locale values                                       |
-| `ORDER`, `Order`                                       | value | Sort order values                                   |
-| `PERMISSION`, `Permission`                             | value | Permission values used by services and clients      |
-| `SUBSCRIPTION_FEATURE`, `SubscriptionFeature`          | value | Subscription feature values scoped like permissions |
+| Export                                                         | Kind  | Purpose                                             |
+| -------------------------------------------------------------- | ----- | --------------------------------------------------- |
+| `HTTP_EXCEPTION_CODE`, `HttpExceptionCode`                     | value | Numeric error codes shared by services and clients  |
+| `ApiErrorBody`                                                 | type  | Business error body `{code, message, statusCode}`   |
+| `DEFAULT_PAGE_SIZE`, `MAX_PAGE_SIZE`                           | value | Paging limits used by every list endpoint           |
+| `PaginationQuery`, `PaginatedResult<T>`                        | type  | Paging request fields and page envelope             |
+| `RESERVED_REQUEST_HEADER`, `ReservedRequestHeaderName`         | value | Headers set by the gateway or authentication layer  |
+| `LANGUAGE`, `Language`                                         | value | Locale values                                       |
+| `EMAIL_TEMPLATE`, `EmailTemplate`                              | value | Email template values used by services and clients  |
+| `ORDER`, `Order`                                               | value | Sort order values                                   |
+| `PAYMENT_CHANNEL`, `PAYMENT_ENVIRONMENT`, `PAYMENT_EVENT_TYPE` | value | Payment contract vocabulary shared by services      |
+| `PERMISSION`, `Permission`                                     | value | Permission values used by services and clients      |
+| `SUBSCRIPTION_FEATURE`, `SubscriptionFeature`                  | value | Subscription feature values scoped like permissions |
 ## Install
@@ -67,7 +69,8 @@ Only values and types that both ends of a wire boundary must agree on belong her
 - numeric error codes and error response bodies
 - query and response shapes shared by API clients and services
 - reserved request header names
-- cross-project enums such as language, sort order, permissions and subscription features
+- cross-project enums such as language, sort order, permissions, subscription features and payment
+  contract values
 Framework-specific code does not belong here: NestJS decorators, guards and interceptors,
 TypeORM entities, HTTP clients, persistence, and service-only DTOs stay in their own libraries.

package/README.zh-CN.md CHANGED Viewed

@@ -5,17 +5,19 @@ ESM 与 CommonJS 两种产物。
 [English](./README.md) | 中文
-| 导出                                                   | 类型 | 用途                                     |
-| ------------------------------------------------------ | ---- | ---------------------------------------- |
-| `HTTP_EXCEPTION_CODE`、`HttpExceptionCode`             | 值   | 服务与客户端共享的数字错误码             |
-| `ApiErrorBody`                                         | 类型 | 业务错误体 `{code, message, statusCode}` |
-| `DEFAULT_PAGE_SIZE`、`MAX_PAGE_SIZE`                   | 值   | 所有列表接口使用的分页上限               |
-| `PaginationQuery`、`PaginatedResult<T>`                | 类型 | 分页请求字段与分页响应信封               |
-| `RESERVED_REQUEST_HEADER`、`ReservedRequestHeaderName` | 值   | 由网关或认证层写入的保留请求头           |
-| `LANGUAGE`、`Language`                                 | 值   | 语言值                                   |
-| `ORDER`、`Order`                                       | 值   | 排序值                                   |
-| `PERMISSION`、`Permission`                             | 值   | 服务与客户端共用的权限值                 |
-| `SUBSCRIPTION_FEATURE`、`SubscriptionFeature`          | 值   | 订阅特性值，与权限使用相同的区域写法     |
+| 导出                                                           | 类型 | 用途                                     |
+| -------------------------------------------------------------- | ---- | ---------------------------------------- |
+| `HTTP_EXCEPTION_CODE`、`HttpExceptionCode`                     | 值   | 服务与客户端共享的数字错误码             |
+| `ApiErrorBody`                                                 | 类型 | 业务错误体 `{code, message, statusCode}` |
+| `DEFAULT_PAGE_SIZE`、`MAX_PAGE_SIZE`                           | 值   | 所有列表接口使用的分页上限               |
+| `PaginationQuery`、`PaginatedResult<T>`                        | 类型 | 分页请求字段与分页响应信封               |
+| `RESERVED_REQUEST_HEADER`、`ReservedRequestHeaderName`         | 值   | 由网关或认证层写入的保留请求头           |
+| `LANGUAGE`、`Language`                                         | 值   | 语言值                                   |
+| `EMAIL_TEMPLATE`、`EmailTemplate`                              | 值   | 服务与客户端共用的邮件模板值             |
+| `ORDER`、`Order`                                               | 值   | 排序值                                   |
+| `PAYMENT_CHANNEL`、`PAYMENT_ENVIRONMENT`、`PAYMENT_EVENT_TYPE` | 值   | 支付服务与订阅服务共用的支付契约词表     |
+| `PERMISSION`、`Permission`                                     | 值   | 服务与客户端共用的权限值                 |
+| `SUBSCRIPTION_FEATURE`、`SubscriptionFeature`                  | 值   | 订阅特性值，与权限使用相同的区域写法     |
 ## 安装
@@ -65,7 +67,7 @@ const page: PaginatedResult<{id: string}> = {
 - 数字错误码与错误响应体
 - API 客户端与服务共享的查询、响应结构
 - 保留请求头名称
-- 语言、排序、权限、订阅特性等跨项目枚举
+- 语言、排序、权限、订阅特性、支付契约值等跨项目枚举
 框架相关代码不放进这里：NestJS 装饰器、守卫、拦截器，TypeORM 实体，HTTP 客户端，持久化，
 以及仅服务端使用的 DTO 都留在各自的库中。

package/dist/index.d.mts CHANGED Viewed

@@ -1,3 +1,9 @@
+declare const EMAIL_TEMPLATE: {
+    readonly RESET_PASSWORD_CAPTCHA: "RESET_PASSWORD_CAPTCHA";
+    readonly SIGN_UP_CAPTCHA: "SIGN_UP_CAPTCHA";
+};
+type EmailTemplate = (typeof EMAIL_TEMPLATE)[keyof typeof EMAIL_TEMPLATE];
 /**
  * Numeric error codes shared by Bearei services and clients.
  * Values are part of the wire contract: append new codes, never renumber or reuse.
@@ -87,6 +93,27 @@ interface PaginatedResult<T> {
     total?: number;
 }
+declare const PAYMENT_CHANNEL: {
+    readonly APPLE_IAP: "APPLE_IAP";
+};
+type PaymentChannel = (typeof PAYMENT_CHANNEL)[keyof typeof PAYMENT_CHANNEL];
+declare const PAYMENT_ENVIRONMENT: {
+    readonly PRODUCTION: "PRODUCTION";
+    readonly SANDBOX: "SANDBOX";
+};
+type PaymentEnvironment = (typeof PAYMENT_ENVIRONMENT)[keyof typeof PAYMENT_ENVIRONMENT];
+declare const PAYMENT_EVENT_TYPE: {
+    readonly ENTERED_GRACE_PERIOD: "ENTERED_GRACE_PERIOD";
+    readonly EXPIRED: "EXPIRED";
+    readonly PLAN_CHANGED: "PLAN_CHANGED";
+    readonly REFUNDED: "REFUNDED";
+    readonly REINSTATED: "REINSTATED";
+    readonly RENEWED: "RENEWED";
+    readonly REVOKED: "REVOKED";
+    readonly SUBSCRIBED: "SUBSCRIBED";
+};
+type PaymentEventType = (typeof PAYMENT_EVENT_TYPE)[keyof typeof PAYMENT_EVENT_TYPE];
 declare const PERMISSION: {
     readonly ACTION_LOG_CREATE: "action-log:create";
     readonly ACTION_LOG_DELETE: "action-log:delete";
@@ -166,5 +193,5 @@ declare const SUBSCRIPTION_FEATURE: {
 };
 type SubscriptionFeature = (typeof SUBSCRIPTION_FEATURE)[keyof typeof SUBSCRIPTION_FEATURE];
-export { DEFAULT_PAGE_SIZE, HTTP_EXCEPTION_CODE, LANGUAGE, MAX_PAGE_SIZE, ORDER, PERMISSION, RESERVED_REQUEST_HEADER, SUBSCRIPTION_FEATURE };
-export type { ApiErrorBody, HttpExceptionCode, Language, Order, PaginatedResult, PaginationQuery, Permission, ReservedRequestHeaderName, SubscriptionFeature };
+export { 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 };
+export type { ApiErrorBody, EmailTemplate, HttpExceptionCode, Language, Order, PaginatedResult, PaginationQuery, PaymentChannel, PaymentEnvironment, PaymentEventType, Permission, ReservedRequestHeaderName, SubscriptionFeature };

package/dist/index.d.ts CHANGED Viewed

@@ -1,3 +1,9 @@
+declare const EMAIL_TEMPLATE: {
+    readonly RESET_PASSWORD_CAPTCHA: "RESET_PASSWORD_CAPTCHA";
+    readonly SIGN_UP_CAPTCHA: "SIGN_UP_CAPTCHA";
+};
+type EmailTemplate = (typeof EMAIL_TEMPLATE)[keyof typeof EMAIL_TEMPLATE];
 /**
  * Numeric error codes shared by Bearei services and clients.
  * Values are part of the wire contract: append new codes, never renumber or reuse.
@@ -87,6 +93,27 @@ interface PaginatedResult<T> {
     total?: number;
 }
+declare const PAYMENT_CHANNEL: {
+    readonly APPLE_IAP: "APPLE_IAP";
+};
+type PaymentChannel = (typeof PAYMENT_CHANNEL)[keyof typeof PAYMENT_CHANNEL];
+declare const PAYMENT_ENVIRONMENT: {
+    readonly PRODUCTION: "PRODUCTION";
+    readonly SANDBOX: "SANDBOX";
+};
+type PaymentEnvironment = (typeof PAYMENT_ENVIRONMENT)[keyof typeof PAYMENT_ENVIRONMENT];
+declare const PAYMENT_EVENT_TYPE: {
+    readonly ENTERED_GRACE_PERIOD: "ENTERED_GRACE_PERIOD";
+    readonly EXPIRED: "EXPIRED";
+    readonly PLAN_CHANGED: "PLAN_CHANGED";
+    readonly REFUNDED: "REFUNDED";
+    readonly REINSTATED: "REINSTATED";
+    readonly RENEWED: "RENEWED";
+    readonly REVOKED: "REVOKED";
+    readonly SUBSCRIBED: "SUBSCRIBED";
+};
+type PaymentEventType = (typeof PAYMENT_EVENT_TYPE)[keyof typeof PAYMENT_EVENT_TYPE];
 declare const PERMISSION: {
     readonly ACTION_LOG_CREATE: "action-log:create";
     readonly ACTION_LOG_DELETE: "action-log:delete";
@@ -166,5 +193,5 @@ declare const SUBSCRIPTION_FEATURE: {
 };
 type SubscriptionFeature = (typeof SUBSCRIPTION_FEATURE)[keyof typeof SUBSCRIPTION_FEATURE];
-export { DEFAULT_PAGE_SIZE, HTTP_EXCEPTION_CODE, LANGUAGE, MAX_PAGE_SIZE, ORDER, PERMISSION, RESERVED_REQUEST_HEADER, SUBSCRIPTION_FEATURE };
-export type { ApiErrorBody, HttpExceptionCode, Language, Order, PaginatedResult, PaginationQuery, Permission, ReservedRequestHeaderName, SubscriptionFeature };
+export { 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 };
+export type { ApiErrorBody, EmailTemplate, HttpExceptionCode, Language, Order, PaginatedResult, PaginationQuery, PaymentChannel, PaymentEnvironment, PaymentEventType, Permission, ReservedRequestHeaderName, SubscriptionFeature };

package/dist/index.js CHANGED Viewed

@@ -21,16 +21,26 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   DEFAULT_PAGE_SIZE: () => DEFAULT_PAGE_SIZE,
+  EMAIL_TEMPLATE: () => EMAIL_TEMPLATE,
   HTTP_EXCEPTION_CODE: () => HTTP_EXCEPTION_CODE,
   LANGUAGE: () => LANGUAGE,
   MAX_PAGE_SIZE: () => MAX_PAGE_SIZE,
   ORDER: () => ORDER,
+  PAYMENT_CHANNEL: () => PAYMENT_CHANNEL,
+  PAYMENT_ENVIRONMENT: () => PAYMENT_ENVIRONMENT,
+  PAYMENT_EVENT_TYPE: () => PAYMENT_EVENT_TYPE,
   PERMISSION: () => PERMISSION,
   RESERVED_REQUEST_HEADER: () => RESERVED_REQUEST_HEADER,
   SUBSCRIPTION_FEATURE: () => SUBSCRIPTION_FEATURE
 });
 module.exports = __toCommonJS(index_exports);
+// src/email-template.enum.ts
+var EMAIL_TEMPLATE = {
+  RESET_PASSWORD_CAPTCHA: "RESET_PASSWORD_CAPTCHA",
+  SIGN_UP_CAPTCHA: "SIGN_UP_CAPTCHA"
+};
 // src/error-code.enum.ts
 var HTTP_EXCEPTION_CODE = {
   ACCESS_DENIED_FOR_GUEST: 401003,
@@ -94,6 +104,25 @@ var ORDER = {
 var DEFAULT_PAGE_SIZE = 10;
 var MAX_PAGE_SIZE = 1024;
+// src/payment.enum.ts
+var PAYMENT_CHANNEL = {
+  APPLE_IAP: "APPLE_IAP"
+};
+var PAYMENT_ENVIRONMENT = {
+  PRODUCTION: "PRODUCTION",
+  SANDBOX: "SANDBOX"
+};
+var PAYMENT_EVENT_TYPE = {
+  ENTERED_GRACE_PERIOD: "ENTERED_GRACE_PERIOD",
+  EXPIRED: "EXPIRED",
+  PLAN_CHANGED: "PLAN_CHANGED",
+  REFUNDED: "REFUNDED",
+  REINSTATED: "REINSTATED",
+  RENEWED: "RENEWED",
+  REVOKED: "REVOKED",
+  SUBSCRIBED: "SUBSCRIBED"
+};
 // src/permission.enum.ts
 var PERMISSION = {
   ACTION_LOG_CREATE: "action-log:create",
@@ -175,10 +204,14 @@ var SUBSCRIPTION_FEATURE = {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   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

package/dist/index.mjs CHANGED Viewed

@@ -1,3 +1,9 @@
+// src/email-template.enum.ts
+var EMAIL_TEMPLATE = {
+  RESET_PASSWORD_CAPTCHA: "RESET_PASSWORD_CAPTCHA",
+  SIGN_UP_CAPTCHA: "SIGN_UP_CAPTCHA"
+};
 // src/error-code.enum.ts
 var HTTP_EXCEPTION_CODE = {
   ACCESS_DENIED_FOR_GUEST: 401003,
@@ -61,6 +67,25 @@ var ORDER = {
 var DEFAULT_PAGE_SIZE = 10;
 var MAX_PAGE_SIZE = 1024;
+// src/payment.enum.ts
+var PAYMENT_CHANNEL = {
+  APPLE_IAP: "APPLE_IAP"
+};
+var PAYMENT_ENVIRONMENT = {
+  PRODUCTION: "PRODUCTION",
+  SANDBOX: "SANDBOX"
+};
+var PAYMENT_EVENT_TYPE = {
+  ENTERED_GRACE_PERIOD: "ENTERED_GRACE_PERIOD",
+  EXPIRED: "EXPIRED",
+  PLAN_CHANGED: "PLAN_CHANGED",
+  REFUNDED: "REFUNDED",
+  REINSTATED: "REINSTATED",
+  RENEWED: "RENEWED",
+  REVOKED: "REVOKED",
+  SUBSCRIBED: "SUBSCRIBED"
+};
 // src/permission.enum.ts
 var PERMISSION = {
   ACTION_LOG_CREATE: "action-log:create",
@@ -141,10 +166,14 @@ var SUBSCRIPTION_FEATURE = {
 };
 export {
   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

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@bearei/contracts",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "description": "Framework-agnostic wire contracts shared by Bearei services, clients and apps",
   "keywords": [
     "bearei",