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

package/src/commands/native/benefit/card-grant/list/command.js

@@ -0,0 +1,135 @@
+'use strict';
+
+const { readTotal } = require('../../../../../execution/list-total');
+
+const { withTargetShopDefault } = require('../../../../../execution/target-shop-default');
+
+const { Option } = require('commander');
+const { DiagnosticCommand } = require('../../../../../cli/diagnostic-command');
+const { inputIssue, parseIntegerOption, constraints, modelAt } = require('../../../../../execution/error-details');
+const { resolveTargetShop } = require('../../../../../execution/target-shop');
+const { validateCommandValue } = require('../../../../../execution/command-schema');
+const { createShopQuery, failure, bindingPath } = require('../../../../../execution/shop-query');
+const { object } = require('../../../../../execution/query-api');
+const schema = require('./schema.json');
+
+const command = 'benefit.card-grant.list';
+const maxResponseBytes = 8 * 1024 * 1024;
+const reject = (category, stage, scope, state, facts) =>
+  failure(command, category, stage, scope, state, facts);
+
+function inputFor(options, context) {
+  const scope = resolveTargetShop(options, context, command);
+  try {
+    const input = { ...scope, pageNo: parseIntegerOption(options.pageNo, schema, '/pageNo'),
+      pageSize: parseIntegerOption(options.pageSize, schema, '/pageSize') };
+    if (options.yzOpenId !== undefined) {
+      if (/[\x00-\x1f\x7f-\x9f]/.test(options.yzOpenId)) throw inputIssue('/yzOpenId', 'invalid_format', constraints(modelAt(schema, 'input', '/yzOpenId')));
+      input.yzOpenId = options.yzOpenId.trim();
+    }
+    validateCommandValue(schema, 'input', input);
+    return Object.freeze(input);
+  } catch (error) { error.inputScope = scope; throw error; }
+}
+
+function requestBody(input, preview = false) {
+  const params = { page: input.pageNo, page_size: input.pageSize };
+  if (input.yzOpenId !== undefined) {
+    params.user = { account_type: 5, account_id: preview ? '***' : input.yzOpenId };
+  }
+  return { params };
+}
+
+function project(data, input, facts) {
+  try {
+    if (!object(data) || !Array.isArray(data.items)) throw new Error('invalid page');
+    const reportedTotal = readTotal(data, 'total');
+    const total = reportedTotal === 0 ? null : reportedTotal;
+    const offset = (input.pageNo - 1) * input.pageSize;
+    const remaining = total === null ? null : Math.max(0, total - offset);
+    if (data.items.length > input.pageSize || (remaining !== null && (data.items.length > remaining ||
+        (data.items.length === 0 && remaining > 0)))) throw new Error('inconsistent page');
+    const cardGrants = data.items.map(source => {
+      if (!object(source)) throw new Error('invalid grant');
+      if (input.yzOpenId !== undefined && source.yz_open_id !== input.yzOpenId) {
+        throw new Error('wrong customer');
+      }
+      const grant = { yzOpenId: source.yz_open_id, cardAlias: source.card_alias,
+        cardNo: source.card_no, originKdtId: source.origin_kdt_id };
+      for (const [field, upstream] of Object.entries({
+        grantId: 'id', cardName: 'card_name', bizType: 'biz_type'
+      })) {
+        if (source[upstream] !== undefined && source[upstream] !== null) grant[field] = source[upstream];
+      }
+      return grant;
+    });
+    const result = { data: { cardGrants, pagination: {
+      pageNo: input.pageNo, pageSize: input.pageSize, returned: cardGrants.length,
+      ...(total === null ? {} : { total }),
+      hasMore: total === null ? null : input.pageNo * input.pageSize < total,
+      nextPageNo: total !== null && total > input.pageNo * input.pageSize && input.pageNo < 2147483647 ? input.pageNo + 1 : null,
+      windowLimitReached: (total === null || total > input.pageNo * input.pageSize) && input.pageNo === 2147483647
+    } } };
+    validateCommandValue(schema, 'output', result);
+    return result;
+  } catch {
+    throw reject('protocol', 'card-grant-list-model', { kdtId: input.kdtId }, 'sent', facts);
+  }
+}
+
+function redactCustomer(error, yzOpenId) {
+  if (!yzOpenId) return;
+  for (const field of ['businessCode', 'gatewayCode', 'trace_id', 'request_id']) {
+    if (String(error.cliDetails?.[field]).includes(yzOpenId)) delete error.cliDetails[field];
+  }
+}
+
+function createCommand({ context } = {}) {
+  return new DiagnosticCommand('list', { path: command, schema, parameterCategory: 'parameter' })
+    .description('分页查询店铺或指定客户的权益卡发放记录')
+    .allowExcessArguments(false)
+    .option('--kdt-id <id>', '目标店铺标识；省略取上下文 shopId，凭证须绑定同店')
+    .option('--yz-open-id <id>', '可选客户 yzOpenId；省略查店铺记录，显式空值拒绝')
+    .option('--page-no <n>', '本次读取的页码，从 1 开始，不自动翻页', '1')
+    .option('--page-size <n>', '本页最多返回的发放记录条数，1 至 50', '20')
+    .addOption(new Option('--format <format>', 'json 或 pretty，仅改变缩进')
+      .choices(['json', 'pretty']).default('json'))
+    .option('--dry-run', '本地预览，客户标识脱敏，不读凭证、不联网')
+    .addHelpText('after', `
+total 只描述本次筛选的接口总数，不保证跨页快照；按 nextPageNo 继续并保留店铺、筛选和容量。
+nextPageNo=null 不能单独解释为结束；windowLimitReached=true 表示达到页码上限，仍有后续。
+输出 data.cardGrants 和 data.pagination。记录关联客户、卡定义、卡号及领卡来源店铺。
+未取得可靠总数时省略 total；接口零值无法区分真实零与回退零时也省略，hasMore 为 null。
+发放记录不证明客户当前持卡、卡仍有效或权益已使用，不按卡号合并历史记录。
+每次只读取一页；来源店铺可以不同于查询店铺，不据它切店或补查。
+先核验凭证同店，再读取记录，最多两请求；每次响应最多 8 MiB。
+失败不输出部分结果，不自动重试、扩大客户范围或翻页。
+契约：zan-saas schema benefit.card-grant.list
+示例：zan-saas benefit card-grant list --kdt-id 63077 --dry-run
+`)
+    .action(async options => {
+      const input = inputFor(options, context);
+      const preview = { scope: { kdtId: input.kdtId }, requests: [
+        { stage: 'shop-binding', method: 'POST', path: bindingPath, body: {} },
+        { stage: 'card-grant-list', method: 'POST', path: schema.api.path,
+          body: requestBody(input, true) }
+      ] };
+      validateCommandValue(schema, 'preview', preview);
+      try {
+        let result = preview;
+        if (!options.dryRun) {
+          const read = await createShopQuery(input, command, {
+            transportOptions: { maxResponseBytes: () => maxResponseBytes }
+          });
+          const response = await read(schema.api.path, requestBody(input), 'card-grant-list');
+          result = project(response.data, input, response.facts);
+        }
+        process.stdout.write(`${JSON.stringify(result, null, options.format === 'pretty' ? 2 : 0)}\n`);
+      } catch (error) {
+        redactCustomer(error, input.yzOpenId);
+        throw error;
+      }
+    });
+}
+
+module.exports = { kind: 'atomic', risk: 'read', at: 'all', createCommand: withTargetShopDefault(createCommand) };