@open-feishu-card/schema 0.1.7 → 0.1.8

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 (5) hide show
  1. package/dist/common/behavior.d.ts +4 -10
  2. package/dist/common/behavior.d.ts.map +1 -1
  3. package/dist/index.cjs +4 -8
  4. package/dist/index.js +4 -8
  5. package/package.json +1 -1
package/dist/common/behavior.d.ts CHANGED
@@ -12,8 +12,8 @@ export declare const OpenUrlBehaviorSchema: z.ZodObject<{
12
12
  }, z.core.$strip>;
13
13
  export type OpenUrlBehavior = z.infer<typeof OpenUrlBehaviorSchema>;
14
14
  /**
15
- * 请求服务端动作交互（客户端 ActionType.ActionRequest）。
16
- * 客户端运行时按 e.type === "action_request" 分派；value 为回传服务端的自定义数据对象。
15
+ * 客户端内部枚举 ActionRequest。开放平台发消息接口不接受这个 type
16
+ * （200621 unknown behavior type），发出去的卡片请用 callback。
17
17
  */
18
18
  export declare const ActionRequestBehaviorSchema: z.ZodObject<{
19
19
  type: z.ZodLiteral<"action_request">;
@@ -31,12 +31,7 @@ export declare const ClientMessageBehaviorSchema: z.ZodObject<{
31
31
  }, z.core.$loose>;
32
32
  export type ClientMessageBehavior = z.infer<typeof ClientMessageBehaviorSchema>;
33
33
  /**
34
- * 回传交互（旧 wire 写法）。
35
- * @deprecated 客户端 ActionType 枚举为 action_request / client_message / open_url，
36
- * 带引号 "callback" 在客户端 chunk 中 0 命中。是否存在 wire JSON callback →
37
- * 内部 action_request 的归一化层无法从压缩代码确证，故保留兼容，新卡片请改用
38
- * action_request。
39
- *
34
+ * 回传交互。开放平台发消息（im/v1/messages）的卡片 JSON 使用这个 type。
40
35
  * value 需为 object；开放平台 SDK 仅支持 object。
41
36
  */
42
37
  export declare const CallbackBehaviorSchema: z.ZodObject<{
@@ -46,8 +41,7 @@ export declare const CallbackBehaviorSchema: z.ZodObject<{
46
41
  export type CallbackBehavior = z.infer<typeof CallbackBehaviorSchema>;
47
42
  /**
48
43
  * 组件交互行为。使用 type 作为判别字段。
49
- * 客户端 ActionType 共三种：action_request / client_message / open_url；
50
- * callback 为旧 wire 写法，保留兼容（归一化层不可见，先不拒绝）。
44
+ * 发消息用 open_url / callback。action_request、client_message 是客户端内部枚举，解析时仍接受。
51
45
  */
52
46
  export declare const BehaviorSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
53
47
  type: z.ZodLiteral<"open_url">;
package/dist/common/behavior.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"behavior.d.ts","sourceRoot":"","sources":["../../src/common/behavior.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,qBAAqB;;;;;;iBAYI,CAAC;AAEvC,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE;;;GAGG;AACH,eAAO,MAAM,2BAA2B;;;iBASO,CAAC;AAEhD,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CACzC,OAAO,2BAA2B,CACnC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,2BAA2B;;;iBAWkB,CAAC;AAE3D,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF;;;;;;;;GAQG;AACH,eAAO,MAAM,sBAAsB;;;iBAWhC,CAAC;AAEJ,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE;;;;GAIG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;2BASxB,CAAC;AAEJ,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAEtD,mBAAmB;AACnB,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;4BAEM,CAAC;AAEnC,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC"}
1
+ {"version":3,"file":"behavior.d.ts","sourceRoot":"","sources":["../../src/common/behavior.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,qBAAqB;;;;;;iBAYI,CAAC;AAEvC,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE;;;GAGG;AACH,eAAO,MAAM,2BAA2B;;;iBASO,CAAC;AAEhD,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CACzC,OAAO,2BAA2B,CACnC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,2BAA2B;;;iBAWkB,CAAC;AAE3D,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF;;;GAGG;AACH,eAAO,MAAM,sBAAsB;;;iBAOG,CAAC;AAEvC,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE;;;GAGG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;2BASxB,CAAC;AAEJ,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAEtD,mBAAmB;AACnB,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;4BAEM,CAAC;AAEnC,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC"}
package/dist/index.cjs CHANGED
@@ -14,7 +14,7 @@ var OpenUrlBehaviorSchema = zod.z.object({
14
14
  }).describe("\u6253\u5F00\u94FE\u63A5\u4EA4\u4E92\uFF08type = open_url\uFF09");
15
15
  var ActionRequestBehaviorSchema = zod.z.object({
16
16
  type: zod.z.literal("action_request").describe(
17
- "\u4EA4\u4E92\u7C7B\u578B\uFF0C\u56FA\u5B9A\u4E3A action_request"
17
+ "\u5BA2\u6237\u7AEF\u5185\u90E8\u4EA4\u4E92\u7C7B\u578B\u3002im/v1/messages \u4E0D\u63A5\u53D7\uFF0C\u53D1\u6D88\u606F\u8BF7\u7528 callback"
18
18
  ),
19
19
  value: zod.z.record(zod.z.string(), zod.z.unknown()).describe("\u56DE\u4F20\u7ED9\u670D\u52A1\u7AEF\u7684\u81EA\u5B9A\u4E49\u6570\u636E\u5BF9\u8C61\uFF1B\u7528\u7B80\u6D01\u4E1A\u52A1\u5B57\u6BB5\u5373\u53EF")
20
20
  }).describe("\u8BF7\u6C42\u670D\u52A1\u7AEF\u52A8\u4F5C\u4EA4\u4E92\uFF08type = action_request\uFF09");
@@ -25,20 +25,16 @@ var ClientMessageBehaviorSchema = zod.z.object({
25
25
  value: zod.z.record(zod.z.string(), zod.z.unknown()).optional().describe("\u5BA2\u6237\u7AEF\u6D88\u606F\u8F7D\u8377\uFF1B\u5B57\u6BB5\u7ED3\u6784\u4EE5\u5BA2\u6237\u7AEF\u5B9E\u9645\u4E3A\u51C6\uFF0C\u6309 value \u900F\u4F20")
26
26
  }).passthrough().describe("\u5BA2\u6237\u7AEF\u6D88\u606F\u4EA4\u4E92\uFF08type = client_message\uFF09\uFF1B\u8F7D\u8377\u5B57\u6BB5\u4EE5\u5BA2\u6237\u7AEF\u5B9E\u9645\u4E3A\u51C6");
27
27
  var CallbackBehaviorSchema = zod.z.object({
28
- type: zod.z.literal("callback").describe(
29
- "\u4EA4\u4E92\u7C7B\u578B\uFF0C\u56FA\u5B9A\u4E3A callback\uFF08@deprecated\uFF0C\u65B0\u5361\u7247\u8BF7\u7528 action_request\uFF09"
30
- ),
28
+ type: zod.z.literal("callback").describe("\u4EA4\u4E92\u7C7B\u578B\uFF0C\u56FA\u5B9A\u4E3A callback"),
31
29
  value: zod.z.record(zod.z.string(), zod.z.unknown()).describe("\u56DE\u4F20\u7ED9\u670D\u52A1\u7AEF\u7684\u81EA\u5B9A\u4E49\u6570\u636E\u5BF9\u8C61\uFF1B\u7528\u7B80\u6D01\u4E1A\u52A1\u5B57\u6BB5\u5373\u53EF")
32
- }).describe(
33
- "\u8BF7\u6C42\u56DE\u8C03\u4EA4\u4E92\uFF08type = callback\uFF0C@deprecated\uFF1B\u65B0\u5361\u7247\u8BF7\u7528 action_request\uFF09"
34
- );
30
+ }).describe("\u8BF7\u6C42\u56DE\u8C03\u4EA4\u4E92\uFF08type = callback\uFF09");
35
31
  var BehaviorSchema = zod.z.discriminatedUnion("type", [
36
32
  OpenUrlBehaviorSchema,
37
33
  ActionRequestBehaviorSchema,
38
34
  ClientMessageBehaviorSchema,
39
35
  CallbackBehaviorSchema
40
36
  ]).describe(
41
- "\u7EC4\u4EF6\u4EA4\u4E92\u884C\u4E3A\uFF1Aopen_url\uFF08\u6253\u5F00\u94FE\u63A5\uFF09/ action_request\uFF08\u8BF7\u6C42\u670D\u52A1\u7AEF\u52A8\u4F5C\uFF09/ client_message\uFF08\u5BA2\u6237\u7AEF\u6D88\u606F\uFF09\uFF1Bcallback \u4E3A\u65E7\u5199\u6CD5\uFF0C\u517C\u5BB9\u4FDD\u7559"
37
+ "\u7EC4\u4EF6\u4EA4\u4E92\u884C\u4E3A\uFF1Aopen_url\uFF08\u6253\u5F00\u94FE\u63A5\uFF09/ callback\uFF08\u8BF7\u6C42\u670D\u52A1\u7AEF\u52A8\u4F5C\uFF09\uFF1Baction_request\u3001client_message \u4E3A\u5BA2\u6237\u7AEF\u5185\u90E8\u679A\u4E3E"
42
38
  );
43
39
  var BehaviorsSchema = zod.z.array(BehaviorSchema).describe("\u7EC4\u4EF6\u4EA4\u4E92\u884C\u4E3A\u5217\u8868\uFF1B\u53EF\u540C\u65F6\u914D\u7F6E\u8DF3\u8F6C\u4E0E\u56DE\u8C03");
44
40
  var ElementIdSchema = zod.z.string().regex(/^[A-Za-z][A-Za-z0-9_]{0,19}$/, {
package/dist/index.js CHANGED
@@ -12,7 +12,7 @@ var OpenUrlBehaviorSchema = z.object({
12
12
  }).describe("\u6253\u5F00\u94FE\u63A5\u4EA4\u4E92\uFF08type = open_url\uFF09");
13
13
  var ActionRequestBehaviorSchema = z.object({
14
14
  type: z.literal("action_request").describe(
15
- "\u4EA4\u4E92\u7C7B\u578B\uFF0C\u56FA\u5B9A\u4E3A action_request"
15
+ "\u5BA2\u6237\u7AEF\u5185\u90E8\u4EA4\u4E92\u7C7B\u578B\u3002im/v1/messages \u4E0D\u63A5\u53D7\uFF0C\u53D1\u6D88\u606F\u8BF7\u7528 callback"
16
16
  ),
17
17
  value: z.record(z.string(), z.unknown()).describe("\u56DE\u4F20\u7ED9\u670D\u52A1\u7AEF\u7684\u81EA\u5B9A\u4E49\u6570\u636E\u5BF9\u8C61\uFF1B\u7528\u7B80\u6D01\u4E1A\u52A1\u5B57\u6BB5\u5373\u53EF")
18
18
  }).describe("\u8BF7\u6C42\u670D\u52A1\u7AEF\u52A8\u4F5C\u4EA4\u4E92\uFF08type = action_request\uFF09");
@@ -23,20 +23,16 @@ var ClientMessageBehaviorSchema = z.object({
23
23
  value: z.record(z.string(), z.unknown()).optional().describe("\u5BA2\u6237\u7AEF\u6D88\u606F\u8F7D\u8377\uFF1B\u5B57\u6BB5\u7ED3\u6784\u4EE5\u5BA2\u6237\u7AEF\u5B9E\u9645\u4E3A\u51C6\uFF0C\u6309 value \u900F\u4F20")
24
24
  }).passthrough().describe("\u5BA2\u6237\u7AEF\u6D88\u606F\u4EA4\u4E92\uFF08type = client_message\uFF09\uFF1B\u8F7D\u8377\u5B57\u6BB5\u4EE5\u5BA2\u6237\u7AEF\u5B9E\u9645\u4E3A\u51C6");
25
25
  var CallbackBehaviorSchema = z.object({
26
- type: z.literal("callback").describe(
27
- "\u4EA4\u4E92\u7C7B\u578B\uFF0C\u56FA\u5B9A\u4E3A callback\uFF08@deprecated\uFF0C\u65B0\u5361\u7247\u8BF7\u7528 action_request\uFF09"
28
- ),
26
+ type: z.literal("callback").describe("\u4EA4\u4E92\u7C7B\u578B\uFF0C\u56FA\u5B9A\u4E3A callback"),
29
27
  value: z.record(z.string(), z.unknown()).describe("\u56DE\u4F20\u7ED9\u670D\u52A1\u7AEF\u7684\u81EA\u5B9A\u4E49\u6570\u636E\u5BF9\u8C61\uFF1B\u7528\u7B80\u6D01\u4E1A\u52A1\u5B57\u6BB5\u5373\u53EF")
30
- }).describe(
31
- "\u8BF7\u6C42\u56DE\u8C03\u4EA4\u4E92\uFF08type = callback\uFF0C@deprecated\uFF1B\u65B0\u5361\u7247\u8BF7\u7528 action_request\uFF09"
32
- );
28
+ }).describe("\u8BF7\u6C42\u56DE\u8C03\u4EA4\u4E92\uFF08type = callback\uFF09");
33
29
  var BehaviorSchema = z.discriminatedUnion("type", [
34
30
  OpenUrlBehaviorSchema,
35
31
  ActionRequestBehaviorSchema,
36
32
  ClientMessageBehaviorSchema,
37
33
  CallbackBehaviorSchema
38
34
  ]).describe(
39
- "\u7EC4\u4EF6\u4EA4\u4E92\u884C\u4E3A\uFF1Aopen_url\uFF08\u6253\u5F00\u94FE\u63A5\uFF09/ action_request\uFF08\u8BF7\u6C42\u670D\u52A1\u7AEF\u52A8\u4F5C\uFF09/ client_message\uFF08\u5BA2\u6237\u7AEF\u6D88\u606F\uFF09\uFF1Bcallback \u4E3A\u65E7\u5199\u6CD5\uFF0C\u517C\u5BB9\u4FDD\u7559"
35
+ "\u7EC4\u4EF6\u4EA4\u4E92\u884C\u4E3A\uFF1Aopen_url\uFF08\u6253\u5F00\u94FE\u63A5\uFF09/ callback\uFF08\u8BF7\u6C42\u670D\u52A1\u7AEF\u52A8\u4F5C\uFF09\uFF1Baction_request\u3001client_message \u4E3A\u5BA2\u6237\u7AEF\u5185\u90E8\u679A\u4E3E"
40
36
  );
41
37
  var BehaviorsSchema = z.array(BehaviorSchema).describe("\u7EC4\u4EF6\u4EA4\u4E92\u884C\u4E3A\u5217\u8868\uFF1B\u53EF\u540C\u65F6\u914D\u7F6E\u8DF3\u8F6C\u4E0E\u56DE\u8C03");
42
38
  var ElementIdSchema = z.string().regex(/^[A-Za-z][A-Za-z0-9_]{0,19}$/, {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@open-feishu-card/schema",
3
- "version": "0.1.7",
3
+ "version": "0.1.8",
4
4
  "description": "飞书卡片 JSON Schema 2.0 的 Zod 规范定义与类型导出",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",