@youzan-cloud/zan-saas-cli 0.0.0-stage → 0.1.0-beta.4

package/src/commands/native/item/item-content/get/schema.json

@@ -0,0 +1,677 @@
+{
+  "schemaVersion": 1,
+  "input": {
+    "type": "object",
+    "required": [
+      "kdtId",
+      "item_id",
+      "channel"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "kdtId": {
+        "type": "integer",
+        "minimum": 1,
+        "maximum": 9007199254740991,
+        "description": "目标店铺 ID。"
+      },
+      "item_id": {
+        "type": "integer",
+        "minimum": 1,
+        "maximum": 9007199254740991,
+        "description": "商品 ID，同一商品在各分店和渠道使用相同值；与目标店铺和渠道一起定位，不接受渠道商品 ID 替代。"
+      },
+      "channel": {
+        "type": "integer",
+        "enum": [
+          0,
+          1
+        ],
+        "description": "0网店、1门店。"
+      }
+    },
+    "description": "CLI 解析参数并完成必要上下文补全后的业务输入；不是直接传入 CLI 的 JSON。原始选项、必填条件和默认值见 options。"
+  },
+  "output": {
+    "type": "object",
+    "required": [
+      "data"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "data": {
+        "type": "object",
+        "required": [
+          "content"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "content": {
+            "$ref": "#/definitions/content"
+          }
+        }
+      }
+    }
+  },
+  "preview": {
+    "type": "object",
+    "required": [
+      "method",
+      "path",
+      "body"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "method": {
+        "const": "POST"
+      },
+      "path": {
+        "const": "youzan.item.itemdesc.get/1.0.0"
+      },
+      "body": {
+        "type": "object",
+        "required": [
+          "request"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "request": {
+            "type": "object",
+            "required": [
+              "kdt_id",
+              "item_id",
+              "channel"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "kdt_id": {
+                "type": "integer",
+                "minimum": 1,
+                "maximum": 9007199254740991,
+                "description": "目标店铺 ID。"
+              },
+              "item_id": {
+                "type": "integer",
+                "minimum": 1,
+                "maximum": 9007199254740991,
+                "description": "商品 ID，同一商品在各分店和渠道使用相同值；与目标店铺和渠道一起定位，不接受渠道商品 ID 替代。"
+              },
+              "channel": {
+                "type": "integer",
+                "enum": [
+                  0,
+                  1
+                ],
+                "description": "0网店、1门店。"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "definitions": {
+    "scope": {
+      "type": "object",
+      "required": [
+        "kdtId",
+        "item_id",
+        "channel"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "kdtId": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 9007199254740991,
+          "description": "目标店铺 ID。"
+        },
+        "item_id": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 9007199254740991,
+          "description": "商品 ID，同一商品在各分店和渠道使用相同值；与目标店铺和渠道一起定位，不接受渠道商品 ID 替代。"
+        },
+        "channel": {
+          "type": "integer",
+          "enum": [
+            0,
+            1
+          ],
+          "description": "0网店、1门店。"
+        }
+      }
+    },
+    "content": {
+      "type": "object",
+      "properties": {
+        "template_id": {
+          "type": [
+            "integer",
+            "null"
+          ],
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "商品页模板ID"
+        },
+        "content": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "详情页内容"
+        },
+        "components": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "商品自定义组件"
+        },
+        "component_cover_image": {
+          "type": [
+            "object",
+            "null"
+          ],
+          "properties": {
+            "image_id": {
+              "type": [
+                "integer",
+                "null"
+              ],
+              "minimum": -9007199254740991,
+              "maximum": 9007199254740991,
+              "description": "图片ID。"
+            },
+            "height": {
+              "type": [
+                "integer",
+                "null"
+              ],
+              "minimum": -9007199254740991,
+              "maximum": 9007199254740991,
+              "description": "高"
+            },
+            "width": {
+              "type": [
+                "integer",
+                "null"
+              ],
+              "minimum": -9007199254740991,
+              "maximum": 9007199254740991,
+              "description": "宽"
+            },
+            "url": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "description": "图片url"
+            }
+          },
+          "additionalProperties": true,
+          "description": "商品组件封面图。微页面 显示 商品封面图。"
+        }
+      },
+      "additionalProperties": true,
+      "description": "返回数据"
+    },
+    "diagnosticExpected": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [],
+      "properties": {
+        "type": {
+          "anyOf": [
+            {
+              "type": "string",
+              "description": "预期的 JSON 类型。"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "description": "预期的 JSON 类型。"
+              }
+            }
+          ],
+          "description": "同版模型允许的类型。"
+        },
+        "enum": {
+          "type": "array",
+          "items": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "number"
+              },
+              {
+                "type": "boolean"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "description": "契约声明的静态标量约束。"
+          },
+          "description": "同版模型允许的静态值。"
+        },
+        "const": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "number"
+            },
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "契约声明的静态标量约束。"
+        },
+        "minimum": {
+          "type": "number",
+          "description": "包含的最小值。"
+        },
+        "maximum": {
+          "type": "number",
+          "description": "包含的最大值。"
+        },
+        "exclusiveMinimum": {
+          "type": "number",
+          "description": "不包含的最小值。"
+        },
+        "exclusiveMaximum": {
+          "type": "number",
+          "description": "不包含的最大值。"
+        },
+        "minLength": {
+          "type": "integer",
+          "description": "最少字符数。"
+        },
+        "maxLength": {
+          "type": "integer",
+          "description": "最多字符数。"
+        },
+        "minItems": {
+          "type": "integer",
+          "description": "最少元素数。"
+        },
+        "maxItems": {
+          "type": "integer",
+          "description": "最多元素数。"
+        },
+        "format": {
+          "type": "string",
+          "description": "同版模型声明的格式。"
+        },
+        "pattern": {
+          "type": "string",
+          "description": "同版模型声明的字符约束。"
+        },
+        "additionalProperties": {
+          "const": false,
+          "description": "对象拒绝契约以外的属性。"
+        },
+        "contains": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "const"
+          ],
+          "properties": {
+            "const": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "number"
+                },
+                {
+                  "type": "boolean"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "description": "契约声明的静态标量约束。"
+            }
+          }
+        },
+        "items": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "enum"
+          ],
+          "properties": {
+            "enum": {
+              "type": "array",
+              "items": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "number"
+                  },
+                  {
+                    "type": "boolean"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ],
+                "description": "契约声明的静态标量约束。"
+              },
+              "description": "元素允许的静态值。"
+            }
+          }
+        }
+      }
+    },
+    "diagnosticIssue": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "source",
+        "reason"
+      ],
+      "properties": {
+        "source": {
+          "enum": [
+            "argv",
+            "input",
+            "context",
+            "output",
+            "preview"
+          ],
+          "description": "问题所属的参数、输入、上下文、结果或预览模型。"
+        },
+        "path": {
+          "type": "string",
+          "description": "对应模型中的 JSON Pointer；不含原始输入或动态字典键。"
+        },
+        "option": {
+          "type": "string",
+          "description": "可定位时给出的已注册 CLI 选项。"
+        },
+        "reason": {
+          "enum": [
+            "required",
+            "invalid_type",
+            "invalid_choice",
+            "out_of_range",
+            "invalid_format",
+            "conditional_required",
+            "constraint",
+            "unexpected_property",
+            "unknown_option",
+            "unknown_command",
+            "excess_arguments",
+            "missing_value"
+          ],
+          "description": "字段违反的约束类型，原始值不回显。"
+        },
+        "expected": {
+          "$ref": "#/definitions/diagnosticExpected",
+          "description": "同版契约的静态预期。"
+        },
+        "relatedPaths": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "description": "关联字段的 JSON Pointer。"
+          },
+          "description": "触发条件约束的关联字段。"
+        }
+      }
+    },
+    "diagnosticRecovery": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "action",
+        "automaticBusinessRetry"
+      ],
+      "properties": {
+        "action": {
+          "enum": [
+            "correct_input",
+            "complete_authentication",
+            "request_access_review",
+            "stop_and_inspect"
+          ],
+          "description": "依次表示修正本地输入、补认证、核对权限或停止核查；仅是说明，不执行操作或授予权限。"
+        },
+        "automaticBusinessRetry": {
+          "const": false,
+          "description": "不据此自动重放业务请求。"
+        }
+      }
+    },
+    "diagnosticExecution": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "requestState",
+        "coverage",
+        "observedAttempts"
+      ],
+      "properties": {
+        "requestState": {
+          "enum": [
+            "not_sent",
+            "sent",
+            "unknown"
+          ],
+          "description": "整次调用尚未发送、已有发送记录或无法排除未知请求；不代表业务完成。"
+        },
+        "coverage": {
+          "enum": [
+            "complete",
+            "partial"
+          ],
+          "description": "请求观察覆盖全部已接入路径，或存在未观测路径；部分覆盖不能声明零请求。"
+        },
+        "observedAttempts": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "本地已进入发送边界的观测次数下界，不是服务端执行次数。"
+        }
+      }
+    }
+  },
+  "modules": {
+    "content": {
+      "base": true,
+      "upstreamPath": "data",
+      "required": true,
+      "description": "商品图文对象，保留HTML、组件字符串、模板及封面；不含基本商品资料和H5加工。"
+    }
+  },
+  "api": {
+    "method": "POST",
+    "path": "youzan.item.itemdesc.get/1.0.0"
+  },
+  "success": {
+    "description": "单个商品图文对象满足模型后输出 data.content。"
+  },
+  "errors": {
+    "description": "失败 stdout 为空，stderr 为一份脱敏错误 JSON，退出码非零；不返回部分成功，不自动重试、切换身份或目标。按 error 模型及安全下一步处理。",
+    "diagnosticsVersion": 2
+  },
+  "notes": [
+    "--kdt-id 省略时使用本次有效上下文 shopId；显式提供的非法值不回退。两者都缺失时拒绝；目标范围、同店核验和服务端权限仍按本命令校验。",
+    "按店铺、商品 ID 和渠道只查询图文，成功返回 data.content；不补查商品资料、H5 或角色。",
+    "HTML 和 components 字符串作为数据返回，不解析、不渲染、不访问其中链接。",
+    "可选字段缺失保持省略，未知扩展保留；缺少图文对象或错型失败，不能据此推断商品不存在。",
+    "不支持分店查询总部或分店渠道互查；at=all 不表示任意跨店授权，员工链路尚未完成真实验收。",
+    "本地 --dry-run 不读取凭证、不联网；预览只证明构造计划，不证明对象存在或权限有效。真实执行仍需有效上下文及目标范围授权，at 声明不替代服务端授权。",
+    "商品标识采用新版口径：item_id/sku_id 跨分店和渠道统一，channel_item_id/channel_sku_id 对应目标店铺渠道的旧标识。商品查询使用统一商品 ID 和渠道，不接受旧渠道 ID 替代，不因标识数值相等而互换。"
+  ],
+  "error": {
+    "type": "object",
+    "required": [
+      "success",
+      "code",
+      "message",
+      "details"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "success": {
+        "const": false
+      },
+      "code": {
+        "const": -10001
+      },
+      "message": {
+        "type": "string",
+        "minLength": 1
+      },
+      "details": {
+        "type": "object",
+        "required": [
+          "category",
+          "stage",
+          "command",
+          "targetScope",
+          "requestState",
+          "nextStep",
+          "errorVersion",
+          "recovery",
+          "execution"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "category": {
+            "type": "string",
+            "enum": [
+              "parameter",
+              "configuration",
+              "transport",
+              "authentication",
+              "permission",
+              "http",
+              "protocol",
+              "business_rejected",
+              "not_found",
+              "scope_unresolved",
+              "pagination_stalled",
+              "budget_exceeded",
+              "missing_alias"
+            ]
+          },
+          "stage": {
+            "type": "string",
+            "minLength": 1
+          },
+          "command": {
+            "const": "item.item-content.get"
+          },
+          "targetScope": {
+            "oneOf": [
+              {
+                "$ref": "#/definitions/scope"
+              },
+              {
+                "type": "object",
+                "maxProperties": 0
+              }
+            ]
+          },
+          "requestState": {
+            "type": "string",
+            "enum": [
+              "not_sent",
+              "sent",
+              "unknown"
+            ],
+            "description": "not_sent 确认本步请求未发送；sent 已取得本步响应；unknown 传输中断，无法确定本步结果。不是整个多步查询的发送汇总。"
+          },
+          "nextStep": {
+            "type": "string",
+            "minLength": 1
+          },
+          "api": {
+            "type": "string",
+            "minLength": 1
+          },
+          "httpStatus": {
+            "type": "integer",
+            "minimum": 100,
+            "maximum": 599
+          },
+          "businessCode": {
+            "oneOf": [
+              {
+                "type": "integer",
+                "minimum": -9007199254740991,
+                "maximum": 9007199254740991
+              },
+              {
+                "type": "string",
+                "pattern": "^-?\\d{1,12}$"
+              }
+            ]
+          },
+          "gatewayCode": {
+            "oneOf": [
+              {
+                "type": "integer",
+                "minimum": -9007199254740991,
+                "maximum": 9007199254740991
+              },
+              {
+                "type": "string",
+                "pattern": "^-?\\d{1,12}$"
+              }
+            ]
+          },
+          "trace_id": {
+            "type": "string",
+            "pattern": "^[a-zA-Z0-9_-]{1,128}$"
+          },
+          "request_id": {
+            "type": "string",
+            "pattern": "^[a-zA-Z0-9_-]{1,128}$"
+          },
+          "errorVersion": {
+            "const": 2,
+            "description": "本命令采用错误诊断协议第二版。"
+          },
+          "issues": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 16,
+            "items": {
+              "$ref": "#/definitions/diagnosticIssue"
+            },
+            "description": "最多十六个已定位问题，不包含收到的原值。"
+          },
+          "issuesTruncated": {
+            "const": true,
+            "description": "问题超过返回上限，当前列表没有穷尽全部问题。"
+          },
+          "recovery": {
+            "$ref": "#/definitions/diagnosticRecovery",
+            "description": "受限的恢复说明，不会自动执行。"
+          },
+          "execution": {
+            "$ref": "#/definitions/diagnosticExecution",
+            "description": "整次调用的请求观察，独立于失败阶段的 requestState。"
+          }
+        }
+      }
+    }
+  }
+}

package/src/commands/native/item/shared/api.js

@@ -0,0 +1,31 @@
+'use strict';
+
+const {
+  QueryError, readApiEnvelope, assertSafeNumbers, object
+} = require('../../../../execution/query-api');
+
+class ItemQueryError extends QueryError {
+  constructor(category, stage, scope, facts = {}, sent = 'not_sent', command = 'item.item.get') {
+    super(category, stage, scope, facts, sent, command,
+      '核对当前命令的 schema、目标店铺及渠道；接口拒绝时核对服务端授权，不自动切换目标。');
+    this.message = `商品查询失败：${category}（${stage}）`;
+  }
+}
+
+async function readApi(path, body, stage, scope, command = 'item.item.get') {
+  const failure = (category, facts = {}, sent = 'sent', at = stage) =>
+    new ItemQueryError(category, at, scope, facts, sent, command);
+  const { result, facts } = await readApiEnvelope(path, body,
+    (category, details, sent, at) => failure(category, details, sent,
+      at === 'configuration' ? at : stage));
+  if (result.success === false || !(result.success === true || [0, 200].includes(result.code))) {
+    throw failure('business_rejected', facts);
+  }
+  // Invalid business data must not erase safe diagnostics from a rejected response.
+  try { assertSafeNumbers(result); }
+  catch { throw failure('protocol', facts); }
+  if (!Object.hasOwn(result, 'data')) throw failure('protocol', facts);
+  return result.data;
+}
+
+module.exports = { ItemQueryError, readApi, object };