@h-ai/api-contract 0.1.0-alpha.67 → 0.1.0-alpha.68

package/dist/payment/index.d.ts

@@ -2,7 +2,16 @@ import * as _orpc_contract from '@orpc/contract';
 import { z } from 'zod';
 import { HaiResult } from '@h-ai/core';
 
-/** Payment 领域 oRPC contract。 */
+/**
+ * Payment 领域 oRPC contract。
+ * @example
+ * ```ts
+ * import { apiContract } from '@h-ai/api-contract'
+ *
+ * const contract = apiContract.payment
+ * void contract
+ * ```
+ */
 declare const paymentContract: {
     orders: {
         create: _orpc_contract.ContractProcedureBuilderWithInputOutput<z.ZodObject<{
@@ -16,13 +25,10 @@ declare const paymentContract: {
             tradeType: z.ZodEnum<{
                 jsapi: "jsapi";
                 h5: "h5";
-                app: "app";
-                native: "native";
-                mini_program: "mini_program";
             }>;
             userId: z.ZodOptional<z.ZodString>;
             metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-        }, z.core.$strip>, z.ZodDiscriminatedUnion<[z.ZodObject<{
+        }, z.core.$strict>, z.ZodDiscriminatedUnion<[z.ZodObject<{
             success: z.ZodLiteral<true>;
             data: z.ZodObject<{
                 provider: z.ZodEnum<{
@@ -33,9 +39,6 @@ declare const paymentContract: {
                 tradeType: z.ZodEnum<{
                     jsapi: "jsapi";
                     h5: "h5";
-                    app: "app";
-                    native: "native";
-                    mini_program: "mini_program";
                 }>;
                 clientParams: z.ZodRecord<z.ZodString, z.ZodUnknown>;
                 prepayId: z.ZodOptional<z.ZodString>;
@@ -177,23 +180,64 @@ declare const paymentContract: {
         }, z.core.$strip>], "success">, Record<never, never>, Record<never, never>>;
     };
 };
+/**
+ * payment 领域公开 procedure 契约的完整类型。
+ * @example
+ * ```ts
+ * import type { PaymentContract } from '@h-ai/api-contract'
+ * import { apiContract } from '@h-ai/api-contract'
+ *
+ * const contract: PaymentContract = apiContract.payment
+ * void contract
+ * ```
+ */
 type PaymentContract = typeof paymentContract;
 
-/** 支付渠道 Schema。 */
+/**
+ * 支付渠道 Schema。
+ * @example
+ * ```ts
+ * import { PaymentProviderSchema } from '@h-ai/api-contract'
+ *
+ * const value = PaymentProviderSchema.parse('wechat')
+ * void value
+ * ```
+ */
 declare const PaymentProviderSchema: z.ZodEnum<{
     wechat: "wechat";
     alipay: "alipay";
     stripe: "stripe";
 }>;
-/** 支付交易类型 Schema。 */
+/**
+ * 完整实现的支付类型：微信 jsapi，支付宝/Stripe h5。
+ * @example
+ * ```ts
+ * import { PaymentTradeTypeSchema } from '@h-ai/api-contract'
+ *
+ * const value = PaymentTradeTypeSchema.parse('jsapi')
+ * void value
+ * ```
+ */
 declare const PaymentTradeTypeSchema: z.ZodEnum<{
     jsapi: "jsapi";
     h5: "h5";
-    app: "app";
-    native: "native";
-    mini_program: "mini_program";
 }>;
-/** 创建支付订单入参 Schema。 */
+/**
+ * 创建支付订单入参 Schema。
+ * @example
+ * ```ts
+ * import { PaymentCreateOrderInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = PaymentCreateOrderInputSchema.parse({
+ *   provider: 'wechat',
+ *   amount: 100,
+ *   description: 'Example order',
+ *   tradeType: 'jsapi',
+ *   userId: 'example-openid'
+ * })
+ * void value
+ * ```
+ */
 declare const PaymentCreateOrderInputSchema: z.ZodObject<{
     provider: z.ZodEnum<{
         wechat: "wechat";
@@ -205,14 +249,32 @@ declare const PaymentCreateOrderInputSchema: z.ZodObject<{
     tradeType: z.ZodEnum<{
         jsapi: "jsapi";
         h5: "h5";
-        app: "app";
-        native: "native";
-        mini_program: "mini_program";
     }>;
     userId: z.ZodOptional<z.ZodString>;
     metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-}, z.core.$strip>;
-/** 创建支付订单业务数据 Schema。 */
+}, z.core.$strict>;
+/**
+ * 创建支付订单业务数据 Schema。
+ * @example
+ * ```ts
+ * import { PaymentCreateOrderDataSchema } from '@h-ai/api-contract'
+ *
+ * const value = PaymentCreateOrderDataSchema.parse({
+ *   provider: 'wechat',
+ *   tradeType: 'jsapi',
+ *   prepayId: 'example-prepay',
+ *   clientParams: {
+ *     appId: 'wx-example',
+ *     timeStamp: '1767225600',
+ *     nonceStr: 'example-nonce',
+ *     package: 'prepay_id=example-prepay',
+ *     signType: 'RSA',
+ *     paySign: 'example-only-signature'
+ *   }
+ * })
+ * void value
+ * ```
+ */
 declare const PaymentCreateOrderDataSchema: z.ZodObject<{
     provider: z.ZodEnum<{
         wechat: "wechat";
@@ -222,18 +284,39 @@ declare const PaymentCreateOrderDataSchema: z.ZodObject<{
     tradeType: z.ZodEnum<{
         jsapi: "jsapi";
         h5: "h5";
-        app: "app";
-        native: "native";
-        mini_program: "mini_program";
     }>;
     clientParams: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     prepayId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
-/** 查询支付订单入参 Schema。 */
+/**
+ * 查询支付订单入参 Schema。
+ * @example
+ * ```ts
+ * import { PaymentQueryOrderInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = PaymentQueryOrderInputSchema.parse({
+ *   orderNo: 'order_1'
+ * })
+ * void value
+ * ```
+ */
 declare const PaymentQueryOrderInputSchema: z.ZodObject<{
     orderNo: z.ZodString;
 }, z.core.$strip>;
-/** 支付订单业务数据 Schema。 */
+/**
+ * 支付订单业务数据 Schema。
+ * @example
+ * ```ts
+ * import { PaymentOrderSchema } from '@h-ai/api-contract'
+ *
+ * const value = PaymentOrderSchema.parse({
+ *   orderNo: 'order_1',
+ *   status: 'pending',
+ *   amount: 0
+ * })
+ * void value
+ * ```
+ */
 declare const PaymentOrderSchema: z.ZodObject<{
     orderNo: z.ZodString;
     transactionId: z.ZodOptional<z.ZodString>;
@@ -247,7 +330,21 @@ declare const PaymentOrderSchema: z.ZodObject<{
     amount: z.ZodNumber;
     paidAt: z.ZodOptional<z.ZodISODateTime>;
 }, z.core.$strip>;
-/** 退款入参 Schema。 */
+/**
+ * 退款入参 Schema。
+ * @example
+ * ```ts
+ * import { PaymentRefundInputSchema } from '@h-ai/api-contract'
+ *
+ * const value = PaymentRefundInputSchema.parse({
+ *   provider: 'wechat',
+ *   orderNo: 'order_1',
+ *   refundNo: 'refund_1',
+ *   amount: 1
+ * })
+ * void value
+ * ```
+ */
 declare const PaymentRefundInputSchema: z.ZodObject<{
     provider: z.ZodEnum<{
         wechat: "wechat";
@@ -259,7 +356,20 @@ declare const PaymentRefundInputSchema: z.ZodObject<{
     amount: z.ZodNumber;
     reason: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
-/** 退款业务数据 Schema。 */
+/**
+ * 退款业务数据 Schema。
+ * @example
+ * ```ts
+ * import { PaymentRefundDataSchema } from '@h-ai/api-contract'
+ *
+ * const value = PaymentRefundDataSchema.parse({
+ *   refundNo: 'refund_1',
+ *   refundId: 'example',
+ *   status: 'processing'
+ * })
+ * void value
+ * ```
+ */
 declare const PaymentRefundDataSchema: z.ZodObject<{
     refundNo: z.ZodString;
     refundId: z.ZodString;
@@ -269,17 +379,97 @@ declare const PaymentRefundDataSchema: z.ZodObject<{
         processing: "processing";
     }>;
 }, z.core.$strip>;
-/** 微信/支付宝通知响应 Schema。 */
+/**
+ * 微信/支付宝通知响应 Schema。
+ * @example
+ * ```ts
+ * import { PaymentNotifyMessageSchema } from '@h-ai/api-contract'
+ *
+ * const value = PaymentNotifyMessageSchema.parse({
+ *   code: 'example-1',
+ *   message: 'example'
+ * })
+ * void value
+ * ```
+ */
 declare const PaymentNotifyMessageSchema: z.ZodObject<{
     code: z.ZodString;
     message: z.ZodString;
 }, z.core.$strip>;
-/** Stripe 通知响应 Schema。 */
+/**
+ * Stripe 通知响应 Schema。
+ * @example
+ * ```ts
+ * import { PaymentStripeNotifyDataSchema } from '@h-ai/api-contract'
+ *
+ * const value = PaymentStripeNotifyDataSchema.parse({
+ *   received: true
+ * })
+ * void value
+ * ```
+ */
 declare const PaymentStripeNotifyDataSchema: z.ZodObject<{
     received: z.ZodBoolean;
 }, z.core.$strip>;
+/**
+ * 按渠道和已实现支付方式创建订单的请求。
+ * @example
+ * ```ts
+ * import type { PaymentCreateOrderInput } from '@h-ai/api-contract'
+ * import { PaymentCreateOrderInputSchema } from '@h-ai/api-contract'
+ *
+ * const value: PaymentCreateOrderInput = PaymentCreateOrderInputSchema.parse({
+ *   provider: 'wechat',
+ *   amount: 100,
+ *   description: 'Example order',
+ *   tradeType: 'jsapi',
+ *   userId: 'example-openid'
+ * })
+ * void value
+ * ```
+ */
 type PaymentCreateOrderInput = z.infer<typeof PaymentCreateOrderInputSchema>;
+/**
+ * 以 HaiResult 区分成功业务数据和公共错误的 PaymentCreateOrderOutput 响应。
+ * @example
+ * ```ts
+ * import type { PaymentCreateOrderOutput } from '@h-ai/api-contract'
+ * import { PaymentCreateOrderDataSchema } from '@h-ai/api-contract'
+ * import { ok } from '@h-ai/core'
+ *
+ * const response: PaymentCreateOrderOutput = ok(PaymentCreateOrderDataSchema.parse({
+ *   provider: 'wechat',
+ *   tradeType: 'jsapi',
+ *   prepayId: 'example-prepay',
+ *   clientParams: {
+ *     appId: 'wx-example',
+ *     timeStamp: '1767225600',
+ *     nonceStr: 'example-nonce',
+ *     package: 'prepay_id=example-prepay',
+ *     signType: 'RSA',
+ *     paySign: 'example-only-signature'
+ *   }
+ * }))
+ * if (response.success) void response.data
+ * ```
+ */
 type PaymentCreateOrderOutput = HaiResult<z.infer<typeof PaymentCreateOrderDataSchema>>;
+/**
+ * 退款请求，金额单位与支付契约一致。
+ * @example
+ * ```ts
+ * import type { PaymentRefundInput } from '@h-ai/api-contract'
+ * import { PaymentRefundInputSchema } from '@h-ai/api-contract'
+ *
+ * const value: PaymentRefundInput = PaymentRefundInputSchema.parse({
+ *   provider: 'wechat',
+ *   orderNo: 'order_1',
+ *   refundNo: 'refund_1',
+ *   amount: 1
+ * })
+ * void value
+ * ```
+ */
 type PaymentRefundInput = z.infer<typeof PaymentRefundInputSchema>;
 
 export { type PaymentContract, PaymentCreateOrderDataSchema, type PaymentCreateOrderInput, PaymentCreateOrderInputSchema, type PaymentCreateOrderOutput, PaymentNotifyMessageSchema, PaymentOrderSchema, PaymentProviderSchema, PaymentQueryOrderInputSchema, PaymentRefundDataSchema, type PaymentRefundInput, PaymentRefundInputSchema, PaymentStripeNotifyDataSchema, PaymentTradeTypeSchema, paymentContract };

package/dist/payment/index.js

@@ -1,4 +1,4 @@
-export { PaymentCreateOrderDataSchema, PaymentCreateOrderInputSchema, PaymentNotifyMessageSchema, PaymentOrderSchema, PaymentProviderSchema, PaymentQueryOrderInputSchema, PaymentRefundDataSchema, PaymentRefundInputSchema, PaymentStripeNotifyDataSchema, PaymentTradeTypeSchema, paymentContract } from '../chunk-JIQINMLG.js';
-import '../chunk-CUU2F6YD.js';
+export { PaymentCreateOrderDataSchema, PaymentCreateOrderInputSchema, PaymentNotifyMessageSchema, PaymentOrderSchema, PaymentProviderSchema, PaymentQueryOrderInputSchema, PaymentRefundDataSchema, PaymentRefundInputSchema, PaymentStripeNotifyDataSchema, PaymentTradeTypeSchema, paymentContract } from '../chunk-R5GDWFYC.js';
+import '../chunk-JKPLID6E.js';
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map