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

package/src/commands/native/stock/log/list/schema.json

@@ -0,0 +1,922 @@
+{
+  "schemaVersion": 1,
+  "input": {
+    "type": "object",
+    "required": [
+      "kdtId",
+      "item_id",
+      "pageNo",
+      "pageSize",
+      "channel",
+      "createdAt"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "kdtId": {
+        "type": "integer",
+        "minimum": 1,
+        "maximum": 9007199254740991,
+        "description": "本次目标店铺，必须等于当前上下文 shopId 及同凭证核验的店铺。"
+      },
+      "item_id": {
+        "type": "integer",
+        "minimum": 1,
+        "maximum": 9007199254740991,
+        "description": "OneID 商品 ID，与目标店铺和渠道一起定位；内部转换为旧日志商品身份。"
+      },
+      "pageNo": {
+        "type": "integer",
+        "minimum": 1,
+        "maximum": 2147483647,
+        "description": "页码，从1开始，最大2147483647"
+      },
+      "pageSize": {
+        "type": "integer",
+        "minimum": 1,
+        "maximum": 100,
+        "description": "默认20；CLI单页预算最大100，仅为 CLI 查询预算。"
+      },
+      "channel": {
+        "type": "integer",
+        "enum": [
+          0,
+          1
+        ],
+        "description": "商品渠道：0 网店，1 门店；商品筛选省略时默认0，与商品ID一起使用。"
+      },
+      "createdAt": {
+        "type": "object",
+        "additionalProperties": false,
+        "minProperties": 1,
+        "properties": {
+          "start": {
+            "type": "string",
+            "format": "beijing-date-time-ms",
+            "description": "窗口起点，北京时间 YYYY-MM-DD HH:mm:ss.SSS，省略时不补值。"
+          },
+          "end": {
+            "type": "string",
+            "format": "beijing-date-time-ms",
+            "description": "窗口终点，北京时间 YYYY-MM-DD HH:mm:ss.SSS，省略时不补值。"
+          }
+        },
+        "required": [
+          "start",
+          "end"
+        ],
+        "description": "--created-at \"START..END\" 解析后的日志时间窗口，必须两端且开始不得晚于结束；秒精度，非零毫秒拒绝，不承诺端点包含性。"
+      }
+    },
+    "description": "CLI 解析参数并完成必要上下文补全后的业务输入；不是直接传入 CLI 的 JSON。原始选项、必填条件和默认值见 options。"
+  },
+  "output": {
+    "type": "object",
+    "required": [
+      "data"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "data": {
+        "type": "object",
+        "required": [
+          "logs",
+          "pagination"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "logs": {
+            "type": "array",
+            "maxItems": 100,
+            "items": {
+              "$ref": "#/definitions/log"
+            },
+            "description": "本页库存操作日志，原顺序和重复记录保留，不按商品/SKU去重。"
+          },
+          "pagination": {
+            "$ref": "#/definitions/pagination"
+          }
+        }
+      }
+    }
+  },
+  "preview": {
+    "type": "object",
+    "required": [
+      "steps",
+      "condition"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "steps": {
+        "type": "array",
+        "minItems": 3,
+        "maxItems": 3,
+        "items": [
+          {
+            "type": "object",
+            "required": [
+              "method",
+              "path",
+              "body"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "method": {
+                "const": "POST"
+              },
+              "path": {
+                "const": "youzan.shop.basic.get/3.0.0"
+              },
+              "body": {
+                "type": "object",
+                "maxProperties": 0
+              }
+            }
+          },
+          {
+            "type": "object",
+            "required": [
+              "method",
+              "path",
+              "body"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "method": {
+                "const": "POST"
+              },
+              "path": {
+                "const": "youzan.item.itemdetail.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
+                      },
+                      "item_id": {
+                        "type": "integer",
+                        "minimum": 1,
+                        "maximum": 9007199254740991,
+                        "description": "OneID 商品 ID。"
+                      },
+                      "channel": {
+                        "type": "integer",
+                        "enum": [
+                          0,
+                          1
+                        ],
+                        "description": "商品渠道：0 网店，1 门店；商品筛选省略时默认0，与商品ID一起使用。"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          {
+            "type": "object",
+            "required": [
+              "method",
+              "path",
+              "body",
+              "bodyFrom"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "method": {
+                "const": "POST"
+              },
+              "path": {
+                "const": "youzan.item.stock.log.query/1.0.0"
+              },
+              "body": {
+                "type": "object",
+                "required": [
+                  "begin_date",
+                  "end_date",
+                  "page_no",
+                  "page_size"
+                ],
+                "additionalProperties": false,
+                "properties": {
+                  "begin_date": {
+                    "type": "string",
+                    "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$",
+                    "description": "有效实际日历时间，按输入字符串传输，不转换时区。"
+                  },
+                  "end_date": {
+                    "type": "string",
+                    "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$",
+                    "description": "有效实际日历时间，按输入字符串传输，不转换时区。"
+                  },
+                  "page_no": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "maximum": 2147483647
+                  },
+                  "page_size": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "maximum": 100
+                  }
+                }
+              },
+              "bodyFrom": {
+                "type": "object",
+                "required": [
+                  "item_id"
+                ],
+                "additionalProperties": false,
+                "properties": {
+                  "item_id": {
+                    "const": "steps[1].data.channel_item_id"
+                  }
+                }
+              }
+            }
+          }
+        ]
+      },
+      "condition": {
+        "const": "核店及商品渠道映射匹配后才读取日志；日志 item_id 来自商品响应的 channel_item_id。"
+      }
+    }
+  },
+  "definitions": {
+    "scope": {
+      "type": "object",
+      "required": [
+        "kdtId",
+        "item_id",
+        "channel"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "kdtId": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 9007199254740991,
+          "description": "本次目标店铺，必须等于当前上下文 shopId 及同凭证核验的店铺。"
+        },
+        "item_id": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 9007199254740991,
+          "description": "OneID 商品 ID，与目标店铺和渠道一起定位；内部转换为旧日志商品身份。"
+        },
+        "channel": {
+          "type": "integer",
+          "enum": [
+            0,
+            1
+          ],
+          "description": "商品渠道：0 网店，1 门店；商品筛选省略时默认0，与商品ID一起使用。"
+        }
+      }
+    },
+    "log": {
+      "type": "object",
+      "required": [
+        "kdt_id",
+        "item_id",
+        "channel_item_id"
+      ],
+      "additionalProperties": true,
+      "properties": {
+        "kdt_id": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 9007199254740991,
+          "description": "所属店铺，必须与本次目标kdtId一致。"
+        },
+        "item_id": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 9007199254740991,
+          "description": "本次已核对的OneID商品 ID。"
+        },
+        "sku_id": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "已取得唯一对应或明确统一字段的OneID规格 ID；历史渠道规格不能映射时省略，不推断为无规格。"
+        },
+        "tid": {
+          "type": "string",
+          "description": "关联有赞订单号，字符串原样保留。"
+        },
+        "event_table_name": {
+          "type": "string",
+          "description": "变更表名称，不据此推断库存模式。"
+        },
+        "event_type": {
+          "type": "string",
+          "description": "变更类型，原值保留，不自行枚举。"
+        },
+        "operator_id": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "操作人ID，安全整数，不推断人员身份。"
+        },
+        "operator_name": {
+          "type": "string",
+          "description": "操作人姓名。"
+        },
+        "stock_change": {
+          "type": "string",
+          "description": "库存值变更详情，例如“1 -> 5”；不是数值增量，不解析、换算或推断单位。"
+        },
+        "column_events": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "变更字段列表详情，例如[“库存变化”]，按字符串数组保留。"
+        },
+        "created_at": {
+          "anyOf": [
+            {
+              "type": "string",
+              "format": "beijing-date-time-ms"
+            },
+            {
+              "const": ""
+            }
+          ],
+          "$comment": "upstream-time:text:empty",
+          "description": "记录创建时间；北京时间 YYYY-MM-DD HH:mm:ss.SSS。业务哨兵原值保留：['']。"
+        },
+        "stock_change_reason": {
+          "type": "integer",
+          "minimum": -2147483648,
+          "maximum": 2147483647,
+          "description": "库存变更原因，按正式Integer类型保留。文档文字示例与类型冲突，不猜枚举名称或自动转字符串。"
+        },
+        "channel_item_id": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 9007199254740991,
+          "description": "日志中的旧渠道商品 ID，与本次商品映射一致。"
+        },
+        "channel_sku_id": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "历史日志渠道规格 ID，原整数保留；负数原值不推断含义。"
+        }
+      }
+    },
+    "pagination": {
+      "type": "object",
+      "required": [
+        "pageNo",
+        "pageSize",
+        "returned",
+        "hasMore",
+        "nextPage",
+        "continuation",
+        "paginationExhausted",
+        "snapshot"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "pageNo": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 2147483647
+        },
+        "pageSize": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 100,
+          "description": "本次请求页大小，CLI预算1～100。"
+        },
+        "returned": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 100,
+          "description": "本页实际返回的日志条数，保留重复记录。"
+        },
+        "hasMore": {
+          "type": [
+            "boolean",
+            "null"
+          ],
+          "description": "true 表示还有后续页，false 表示已确认没有后续页；无法确定时为 null，不以空页或短页推算。"
+        },
+        "nextPage": {
+          "type": [
+            "integer",
+            "null"
+          ],
+          "minimum": 1,
+          "maximum": 2147483647
+        },
+        "continuation": {
+          "enum": [
+            "none",
+            "next_page",
+            "page_limit"
+          ]
+        },
+        "paginationExhausted": {
+          "type": "boolean",
+          "description": "仅依据上游报告总数的分页末尾信号，不表示静态全集或完整时序。"
+        },
+        "snapshot": {
+          "const": false
+        },
+        "total": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "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": {
+    "logs": {
+      "base": true,
+      "upstreamPath": "data.items",
+      "required": true,
+      "description": "同凭据授权店铺已核对后取得的当前一页日志。"
+    },
+    "pagination": {
+      "base": true,
+      "upstreamPath": "data.paginator",
+      "required": true,
+      "description": "单页分页信息，未报告总数保持未知。"
+    }
+  },
+  "api": {
+    "method": "POST",
+    "path": "youzan.item.stock.log.query/1.0.0"
+  },
+  "success": {
+    "description": "凭证店铺、上下文及目标一致，日志店铺和商品匹配且本页满足模型后成功。"
+  },
+  "errors": {
+    "description": "失败 stdout 为空，stderr 为一份脱敏错误 JSON，退出码非零；不返回部分成功，不自动重试、切换身份或目标。按 error 模型及安全下一步处理。",
+    "diagnosticsVersion": 2
+  },
+  "notes": [
+    "--kdt-id 省略时使用本次有效上下文 shopId；显式提供的非法值不回退。两者都缺失时拒绝；目标范围、同店核验和服务端权限仍按本命令校验。",
+    "--kdt-id 必须等于有效上下文 shopId，所有组织均如此；at=all 不表示任意跨店或全部产品支持。",
+    "每次只查询一页，默认第 1 页、每页 20 条，页大小 1 至 100；保留顺序和重复，不自动翻页。",
+    "缺少总数时 hasMore=null，不按空页或短页推断结束；page_limit 不表示完整，snapshot=false。",
+    "不解析 stock_change、不从日志计算当前库存或猜测增减单位；column_events 为字符串数组。",
+    "时间输入为北京时间，起点不得晚于终点，仅支持秒精度，非零毫秒拒绝；输出时间点固定三位毫秒。",
+    "最多一次店铺核验、一次商品渠道映射和一次日志读取；requestState 只描述当前错误步骤，不代表之前未发送核验请求。",
+    "本地 --dry-run 不读取凭证、不联网；预览只证明构造计划，不证明对象存在或权限有效。真实执行仍需有效上下文及目标范围授权，at 声明不替代服务端授权。",
+    "每步响应解析后最多 10 MiB，最终 stdout 含 pretty 缩进最多 5 MiB，超限整体失败、不截断；不是流式网络读取或内存硬上限。",
+    "输入商品ID为OneID；旧日志商品/规格ID分别输出channel_item_id/channel_sku_id。规格无法映射时只保留渠道规格，统一sku_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": "stock.log.list"
+          },
+          "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。"
+          }
+        }
+      }
+    }
+  }
+}