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

package/src/commands/native/interaction/lottery/list/command.js

@@ -0,0 +1,176 @@
+'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, withInputScope, 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 { formatDateTime } = require('../../../../../execution/datetime');
+const schema = require('./schema.json');
+
+const command = 'interaction.lottery.list';
+const bindingResponseBytes = 512 * 1024;
+const queryResponseBytes = 8 * 1024 * 1024;
+
+function reject(category, stage, scope = {}, requestState = 'not_sent', facts = {}) {
+  const error = failure(command, category, stage, scope, requestState, facts);
+  error.cliDetails.nextStep = stage === 'shop-binding' ?
+    '主查询未发送。核对原凭证绑定店铺及目标，不自动切换店铺、身份或重试。' :
+    '核对原店铺、玩法、筛选、页码和服务端授权；结果不完整时停止，不自动重放、换店或补查详情。';
+  return error;
+}
+
+function buildInput(options, context) {
+  let scope;
+  try { scope = resolveTargetShop(options, context, command); }
+  catch (error) {
+    if (['scope', 'validation'].includes(error.cliDetails?.stage)) error.cliDetails.stage = 'input';
+    throw error;
+  }
+  try { return withInputScope(scope, () => {
+    const input = { kind: options.kind, ...scope, state: parseIntegerOption(options.state, schema, '/state'),
+      pageNo: parseIntegerOption(options.pageNo, schema, '/pageNo'),
+      pageSize: parseIntegerOption(options.pageSize, schema, '/pageSize') };
+    if (options.keyword !== undefined) {
+      if (typeof options.keyword !== 'string' || /[\u0000-\u001f\u007f-\u009f]/.test(options.keyword)) {
+        throw inputIssue('/keyword', 'invalid_format', constraints(modelAt(schema, 'input', '/keyword')));
+      }
+      input.keyword = options.keyword.trim();
+    }
+    validateCommandValue(schema, 'input', input);
+    return input;
+  }); } catch (error) {
+    error.cliDetails = reject('validation', 'input', scope).cliDetails;
+    throw error;
+  }
+}
+
+function previewFor(input) {
+  const condition = { state: input.state, app_name: input.kind,
+    page_no: input.pageNo, page_size: input.pageSize };
+  if (Object.hasOwn(input, 'keyword')) condition.keyword = input.keyword;
+  return {
+    scope: { kdtId: input.kdtId },
+    prerequisites: ['context', 'token-shop-binding'],
+    requests: [
+      { method: 'POST', api: bindingPath, body: {} },
+      { method: 'POST', api: schema.api.path, body: { search_condition_d_t_o: condition } }
+    ],
+    limits: { maxBusinessRequests: 2, bindingResponseBytes, queryResponseBytes }
+  };
+}
+
+function selected(source, fields) {
+  return Object.fromEntries(Object.entries(fields).filter(([key]) => Object.hasOwn(source, key))
+    .map(([key, name]) => [name, source[key]]));
+}
+
+function projectItem(item, kind) {
+  if (!object(item) || item.app_name !== kind) throw new Error('Invalid lottery');
+  const result = { activityId: item.id, title: item.title, kind: item.app_name, status: item.activity_status,
+    ...selected(item, { alias: 'alias' }) };
+  for (const [source, target] of [['start_date', 'startsAt'], ['end_date', 'endsAt']]) {
+    if (Object.hasOwn(item, source)) result[target] = formatDateTime(item[source]);
+  }
+  const limits = selected(item, { limit_times_type: 'type', limit_times_value: 'count' });
+  if (Object.keys(limits).length) result.limits = limits;
+  if (Object.hasOwn(item, 'awards')) {
+    if (!Array.isArray(item.awards)) throw new Error('Invalid awards');
+    result.awards = item.awards.map(award => {
+      if (!object(award)) throw new Error('Invalid award');
+      return { awardId: award.id, ...selected(award, { award_name: 'name' }) };
+    });
+  }
+  const statistics = selected(item, { total_people_num: 'participantCount',
+    total_join_times: 'participationCount', total_winning_times: 'winningCount',
+    total_winning_num: 'winnerCount', total_un_winning_num: 'nonWinnerCount' });
+  if (Object.keys(statistics).length) result.statistics = statistics;
+  return result;
+}
+
+function project(envelope, input) {
+  if (!Array.isArray(envelope.items) || !object(envelope.paginator)) throw new Error('Invalid page');
+  const paginator = envelope.paginator;
+  const total = readTotal(paginator, 'total_count');
+  const offset = (input.pageNo - 1) * input.pageSize;
+  if (paginator.page !== input.pageNo || paginator.page_size !== input.pageSize ||
+      envelope.items.length > input.pageSize || (total !== null && (total < envelope.items.length ||
+      (envelope.items.length === 0 && offset < total)))) throw new Error('Inconsistent page');
+  const hasMore = total === null ? null : input.pageNo * input.pageSize < total;
+  const output = { data: {
+    lotteries: envelope.items.map(item => projectItem(item, input.kind)),
+    pagination: { pageNo: paginator.page, pageSize: paginator.page_size, ...(total === null ? {} : { total }),
+      hasMore, nextPageNo: hasMore === true && input.pageNo < 1000 ? input.pageNo + 1 : null,
+      windowLimitReached: hasMore !== false && input.pageNo === 1000 }
+  } };
+  validateCommandValue(schema, 'output', output);
+  return output;
+}
+
+function createCommand({ context } = {}) {
+  return new DiagnosticCommand('list', { path: command, schema, parameterCategory: 'parameter' })
+    .description('按明确玩法查询一页抽奖活动、参与限制、奖项摘要及已返回统计')
+    .allowExcessArguments(false)
+    .addOption(new Option('--kind <kind>', 'string，必填。抽奖玩法：cards刮刮卡、wheel幸运大抽奖、zodiac生肖翻翻看、crazyguess疯狂猜猜猜、shake有赞摇一摇。')
+      .choices(['cards', 'wheel', 'zodiac', 'crazyguess', 'shake']).makeOptionMandatory())
+    .option('--kdt-id <id>', 'integer，可选。目标店铺ID，默认context.shopId；须为正安全整数，非总部不可跨店。')
+    .option('--state <state>', 'integer，可选。活动筛选：0全部、1未开始、2活动中、3已结束，默认0；不是返回status码。', '0')
+    .option('--keyword <text>', 'string，可选。活动名称关键字，服务端模糊查询；trim后非空，拒绝控制字符。')
+    .option('--page-no <number>', 'integer，可选。页码，范围1..1000，默认1。', '1')
+    .option('--page-size <number>', 'integer，可选。每页条数上限，范围1..200，默认20。', '20')
+    .addOption(new Option('--format <format>', 'string，可选。输出格式：json紧凑、pretty缩进，默认json。')
+      .choices(['json', 'pretty']).default('json'))
+    .option('--dry-run', 'boolean，可选。本地预览，默认false；零认证、零网络。')
+    .addHelpText('after', `
+total 只描述本次筛选的接口总数，不保证跨页快照；按 nextPageNo 继续并保留店铺、筛选和容量。
+nextPageNo=null 不能单独解释为结束；windowLimitReached=true 表示达到页码上限，仍有后续。
+返回 data.lotteries 和 data.pagination：pageNo、pageSize、total、hasMore、nextPageNo、windowLimitReached。
+返回 status：1未开始、2进行中、3暂停中、4已结束；未知安全整数保留，不按时钟重算。
+limits.type：1一天N次、2一人N次，N为count；未知整数保留，不解释为无限次。
+奖项仅含awardId及可选name，不代表客户中奖或实际资产到账；可选字段缺失省略。
+空页只表示本次玩法及筛选范围，不证明活动全局不存在。第1000页仍可能hasMore，不能请求1001页。
+核验响应最多512 KiB，主响应最多8 MiB；超限整体失败，不截断、不补查详情或伪造归属。
+真实执行需有效上下文及同店授权。支持微商城单店、教育多校区总部，at不证明产品或员工授权。
+不自动重试、换token或换店。预览不证明对象存在或授权有效。
+契约：zan-saas schema interaction.lottery.list
+示例：zan-saas interaction lottery list --kind wheel
+示例：zan-saas interaction lottery list --kind cards --kdt-id 63077 --dry-run
+`)
+    .action(async options => {
+      const input = buildInput(options, context);
+      const preview = previewFor(input);
+      validateCommandValue(schema, 'preview', preview);
+      let output = preview;
+      if (!options.dryRun) {
+        let binding = true;
+        let response;
+        try {
+          const read = await createShopQuery(preview.scope, command, {
+            transportOptions: { maxResponseBytes: () => binding ? bindingResponseBytes : queryResponseBytes }
+          });
+          binding = false;
+          response = await read(schema.api.path, preview.requests[1].body, 'query');
+        } catch (error) {
+          if (error.cliDetails) {
+            const details = error.cliDetails;
+            const stage = details.category === 'limit' && !binding ? 'response' : details.stage;
+            throw reject(details.category, stage, preview.scope, details.requestState,
+              Object.fromEntries(['api', 'httpStatus', 'businessCode', 'gatewayCode', 'trace_id', 'request_id']
+                .filter(key => Object.hasOwn(details, key)).map(key => [key, details[key]])));
+          }
+          throw error;
+        }
+        try { output = project(response.envelope, input); }
+        catch { throw reject('protocol', 'response', preview.scope, 'sent', response.facts); }
+      }
+      process.stdout.write(`${JSON.stringify(output, null, options.format === 'pretty' ? 2 : 0)}\n`);
+    });
+}
+
+module.exports = { kind: 'atomic', risk: 'read', at: 'all', createCommand: withTargetShopDefault(createCommand) };