weaver-work-cli 0.1.6 → 0.1.7

package/dist/shortcuts/okr/operations/read.js

@@ -0,0 +1,481 @@
+import { okrApiError, okrValidationError } from '../errors.js';
+import { businessMessage, isDatajsonSuccess } from '../host.js';
+import { OKR_EB_FORM_TAG, buildStandardDetailPath, createDetailUrlResolver, fetchGoalRaw, okrAbsoluteUrl, resolveEbFormId, resolveLink, } from './link.js';
+import { assertLinkSupported, buildGoalTable, compact, ebMainTables, ebPeriodFilters, normalizeEbGoal, normalizeStandardGoal, resolvePeriod, toIdString, toPersonIdString, } from './shared.js';
+import { okrSuccess, schemaOf, SCHEMA_ID, SCHEMA_PERSON_ID } from './types.js';
+// ---------------------------------------------------------------------------
+// 链路判定（租户缓存 1 天，禁止跳过缓存直接调用 okr_searchAppver）
+// ---------------------------------------------------------------------------
+const okrVersionCheck = {
+    name: 'okr.version.check',
+    resource: 'okr',
+    method: 'version.check',
+    action: 'okr.version.check',
+    summary: '判定当前租户的 OKR 目标接口链路（standard / eb）：先读 1 天租户缓存，未命中才调用 okr_searchAppver 读取 ver_name',
+    capability: 'okr',
+    risk: 'read',
+    inputSchema: schemaOf({
+        refresh: { type: 'boolean', default: false, description: 'true 时忽略缓存重新调用版本接口' },
+    }),
+    handler: async (args, { host }) => {
+        const info = await resolveLink(host, { refresh: args.refresh === true });
+        return okrSuccess('okr.version.check', {
+            ...info,
+            versionInterface: 'okr_searchAppver',
+        });
+    },
+};
+// ---------------------------------------------------------------------------
+// ebuilder 目标详情表单 id（长期缓存）
+// ---------------------------------------------------------------------------
+const okrEbFormResolve = {
+    name: 'okr.eb.form.resolve',
+    resource: 'okr',
+    method: 'eb.form.resolve',
+    action: 'okr.eb.form.resolve',
+    summary: '解析 ebuilder 目标详情表单 id（appTag weaver-wr-goal-eb + formTag uf_wrgm_baseinfo），用于生成目标详情页链接；结果按租户长期缓存',
+    capability: 'okr',
+    risk: 'read',
+    inputSchema: schemaOf({}),
+    handler: async (_args, { host }) => {
+        const { link } = await resolveLink(host);
+        assertLinkSupported(link, 'eb', 'okr.eb.form.resolve', '当前租户走 e10 标准版链路，目标详情页地址为 /sp/goal/openDetail?id=目标id，无需 ebuilder 表单 id');
+        const info = await resolveEbFormId(host);
+        return okrSuccess('okr.eb.form.resolve', { ...info, appTag: info.appTag, formTag: OKR_EB_FORM_TAG });
+    },
+};
+// ---------------------------------------------------------------------------
+// 目标详情页链接
+// ---------------------------------------------------------------------------
+function toIdList(value) {
+    if (Array.isArray(value))
+        return value.map((item) => toIdString(item, 'ids'));
+    if (typeof value === 'string' || typeof value === 'number') {
+        return String(value)
+            .split(',')
+            .map((part) => part.trim())
+            .filter((part) => part !== '')
+            .map((part) => toIdString(part, 'ids'));
+    }
+    throw okrValidationError('ids_required', 'ids 必填，传目标 ID 数组或英文逗号拼接的目标 ID 字符串');
+}
+const okrViewlink = {
+    name: 'okr.viewlink',
+    resource: 'okr',
+    method: 'viewlink',
+    action: 'okr.viewlink',
+    summary: '为已有目标 ID 生成可点击的目标详情页链接（标准版 /sp/goal/openDetail?id=，eb 版 /sp/ebdfpage/card/0/表单id/目标id）',
+    capability: 'okr',
+    risk: 'read',
+    inputSchema: schemaOf({
+        ids: {
+            oneOf: [
+                { type: 'array', items: SCHEMA_ID, minItems: 1 },
+                { type: 'string', pattern: '^\\d+(,\\d+)*$' },
+            ],
+            description: '目标 ID 数组，或英文逗号拼接的目标 ID 字符串',
+        },
+        anchor: { type: 'string', minLength: 1, description: '链接展示文案，默认用目标名称；未查详情时默认「查看详情」' },
+    }, { required: ['ids'] }),
+    handler: async (args, { host }) => {
+        const ids = toIdList(args.ids);
+        const { link } = await resolveLink(host);
+        const resolver = await createDetailUrlResolver(host, link);
+        const links = [];
+        const session = await host.getSession();
+        for (const id of ids) {
+            const path = await resolver.resolve(id);
+            links.push({
+                goalId: id,
+                path,
+                url: okrAbsoluteUrl(session.baseUrl, path),
+                anchor: typeof args.anchor === 'string' && args.anchor ? args.anchor : '查看详情',
+            });
+        }
+        const available = links.every((item) => Boolean(item.path));
+        if (!available) {
+            return okrSuccess('okr.viewlink', {
+                status: 'VIEWLINK_UNAVAILABLE',
+                link,
+                available: false,
+                links,
+                warnings: resolver.warnings.length > 0 ? resolver.warnings : ['目标详情页链接暂不可用'],
+            });
+        }
+        return okrSuccess('okr.viewlink', { status: 'COMPLETE', link, available: true, links });
+    },
+};
+// ---------------------------------------------------------------------------
+// 分页查询目标
+// ---------------------------------------------------------------------------
+function pageOf(args) {
+    const pageNo = args.page_no === undefined ? 1 : Number(args.page_no);
+    const pageSize = args.page_size === undefined ? 10 : Number(args.page_size);
+    if (!Number.isInteger(pageNo) || pageNo < 1) {
+        throw okrValidationError('page_invalid', 'page_no 必须是大于 0 的整数');
+    }
+    if (!Number.isInteger(pageSize) || pageSize < 1 || pageSize > 100) {
+        throw okrValidationError('page_invalid', 'page_size 必须是 1 到 100 之间的整数');
+    }
+    return { pageNo, pageSize };
+}
+function resolveQueryScope(args) {
+    const scope = args.query_scope === undefined ? 'self' : String(args.query_scope);
+    if (scope !== 'self' && scope !== 'all') {
+        throw okrValidationError('query_scope_invalid', 'query_scope 取值必须是 self（本人对应周期）或 all（跨人检索）');
+    }
+    return scope;
+}
+const okrList = {
+    name: 'okr.list',
+    resource: 'okr',
+    method: 'list',
+    action: 'okr.list',
+    summary: '分页查询 OKR 目标，返回固定四列（目标名称、目标责任人名称、目标周期类型、目标周期范围）的表格，目标名称可点击跳转详情',
+    capability: 'okr',
+    risk: 'read',
+    inputSchema: schemaOf({
+        query_scope: {
+            type: 'string',
+            enum: ['self', 'all'],
+            default: 'self',
+            description: 'self=查询本人对应周期目标；all=按条件跨人检索',
+        },
+        period_type: { type: 'string', enum: ['1', '2', '3', '4'], description: '周期类型：1-年度 2-季度 3-月度 4-自定义（self 必填）' },
+        period_range: { type: 'string', description: '周期范围：年度/季度为 yyyy，月度为 yyyy-MM，自定义为「开始日期,结束日期」' },
+        period_quarter: { type: 'string', enum: ['1', '2', '3', '4'], description: '季度值（period_type=2 时必填）' },
+        name: { type: 'string', minLength: 1, description: '目标名称关键字（仅标准版链路，模糊匹配）' },
+        principalid: SCHEMA_PERSON_ID,
+        status: { type: 'string', pattern: '^\\d+(,\\d+)*$', description: '目标状态码，英文逗号拼接（仅标准版链路）' },
+        match: { type: 'string', enum: ['and', 'or'], default: 'and', description: '多条件关系（仅标准版链路）' },
+        page_no: { type: 'integer', minimum: 1, default: 1 },
+        page_size: { type: 'integer', minimum: 1, maximum: 100, default: 10 },
+    }, { description: 'self 模式必填 period_type + period_range；all 模式按需传 name / principalid / status' }),
+    handler: async (args, { host }) => {
+        const { pageNo, pageSize } = pageOf(args);
+        const queryScope = resolveQueryScope(args);
+        const { link } = await resolveLink(host);
+        const session = await host.getSession();
+        const resolver = await createDetailUrlResolver(host, link);
+        const warnings = [];
+        const notes = [];
+        const hasPeriod = args.period_type !== undefined || args.period_range !== undefined;
+        if (queryScope === 'self' && !hasPeriod) {
+            throw okrValidationError('period_required', 'query_scope=self 时必须传 period_type 与 period_range');
+        }
+        const period = hasPeriod ? resolvePeriod(args) : null;
+        let goals = [];
+        let raw;
+        let paging = {};
+        if (link === 'standard') {
+            const body = compact({
+                page: pageNo,
+                pageSize,
+                viewType: 'list',
+                ...(queryScope === 'self'
+                    ? {
+                        condtype: '1',
+                        subcondtype: '1',
+                        status: 1,
+                        statusList: [{ content: '0,1,4,5,6' }],
+                    }
+                    : {
+                        condtype: '4',
+                        subcondtype: '6',
+                        isMore: 0,
+                        scopeId: '0',
+                        hideSubDep: 0,
+                        hideSub: 1,
+                        statusList: [{ content: args.status === undefined ? '1,2,4,5,6,7' : String(args.status) }],
+                        type: args.match === undefined ? 'and' : String(args.match),
+                        ...(args.name === undefined ? {} : { nameList: [{ mode: 'contain', content: String(args.name) }] }),
+                        ...(args.principalid === undefined
+                            ? {}
+                            : { principalidList: [{ mode: 'eq', content: toPersonIdString(args.principalid, 'principalid') }] }),
+                    }),
+            });
+            if (period) {
+                body.periodType = period.periodType;
+                body.periodRange = period.periodRange;
+                if (period.periodQuarter)
+                    body.periodQuarter = Number(period.periodQuarter);
+            }
+            raw = await host.request({
+                method: 'POST',
+                path: '/api/workrelate/goal/getSearchList',
+                operation: 'okr.list',
+                body,
+            });
+            const list = Array.isArray(raw?.data?.list) ? raw.data.list : [];
+            goals = [];
+            for (const item of list) {
+                const goalId = item?.id === undefined || item?.id === null ? null : String(item.id);
+                const detailUrl = okrAbsoluteUrl(session.baseUrl, await resolver.resolve(goalId));
+                goals.push(normalizeStandardGoal(item, detailUrl, item?.keyresultList));
+            }
+            const total = raw?.data?.total ?? raw?.data?.count;
+            if (total !== undefined && total !== null)
+                paging.total = Number(total);
+            paging.hasNext = list.length === pageSize;
+        }
+        else {
+            // eb 链路：列表筛选只支持源资料列出的字段（creator / principalid / 周期字段），
+            // 名称模糊匹配与状态多选不具备实现依据，明确报错而不是静默忽略。
+            if (args.name !== undefined || args.status !== undefined) {
+                throw okrValidationError('link_filter_unsupported', 'ebuilder 链路的分页查询接口不支持按目标名称关键字或目标状态筛选；请改用 query_scope=self 或 principalid + 周期条件', { link, unsupportedFilters: ['name', 'status'] });
+            }
+            const mainTable = compact({
+                ...(queryScope === 'self' ? { creator: session.userId } : {}),
+                ...(args.principalid === undefined
+                    ? {}
+                    : { principalid: toPersonIdString(args.principalid, 'principalid') }),
+                ...(period ? ebPeriodFilters(period) : {}),
+            });
+            raw = await host.request({
+                method: 'POST',
+                path: '/api/ebuilder/form/formdata/v2/getFormDataList/okr_pageQueryGoal',
+                operation: 'okr.list',
+                body: {
+                    datajson: {
+                        mainTable,
+                        pageInfo: { pageNo: String(pageNo), pageSize: String(pageSize) },
+                        header: { operator: session.userId },
+                    },
+                },
+            });
+            if (!isDatajsonSuccess(raw)) {
+                throw okrApiError('business_error', businessMessage(raw), { response: businessMessage(raw) });
+            }
+            const tables = ebMainTables(raw);
+            goals = [];
+            for (const mainTable of tables) {
+                const goalId = mainTable?.id === undefined || mainTable?.id === null ? null : String(mainTable.id);
+                const detailUrl = okrAbsoluteUrl(session.baseUrl, await resolver.resolve(goalId));
+                goals.push(normalizeEbGoal(mainTable, detailUrl));
+            }
+            paging.hasNext = tables.length === pageSize;
+        }
+        warnings.push(...resolver.warnings);
+        return okrSuccess('okr.list', {
+            status: 'COMPLETE',
+            link,
+            queryScope,
+            period: period
+                ? { periodType: period.periodType, periodRange: period.periodRange, periodQuarter: period.periodQuarter ?? null }
+                : null,
+            page: { pageNo, pageSize, ...paging },
+            count: goals.length,
+            goals,
+            table: buildGoalTable(goals),
+        }, { notes, ...(warnings.length > 0 ? { warnings } : {}) });
+    },
+};
+async function fetchCommentCount(host, goalId) {
+    try {
+        const response = await host.request({
+            method: 'POST',
+            path: '/api/goal/common/comment/commentPage',
+            operation: 'okr.get',
+            body: { pageNo: 1, pageSize: 1, targetId: goalId, module: 'goal', foldCommentList: false },
+        });
+        const total = response?.data?.page?.totalCount;
+        return { totalCount: total === undefined || total === null ? 0 : Number(total), unavailable: false };
+    }
+    catch {
+        return { totalCount: null, unavailable: true };
+    }
+}
+const okrGet = {
+    name: 'okr.get',
+    resource: 'okr',
+    method: 'get',
+    action: 'okr.get',
+    summary: '按目标 ID 查询单个目标详情；标准版链路会额外查询评论总条数并只返回「是否需要查看评论内容」的提示，不输出评论正文',
+    capability: 'okr',
+    risk: 'read',
+    inputSchema: schemaOf({
+        id: SCHEMA_ID,
+        include_comment_count: {
+            type: 'boolean',
+            default: true,
+            description: '是否查询评论总条数（仅标准版链路生效，源资料要求查询详情时执行）',
+        },
+    }, { required: ['id'] }),
+    handler: async (args, { host }) => {
+        const goalId = toIdString(args.id, 'id');
+        const { link } = await resolveLink(host);
+        const resolver = await createDetailUrlResolver(host, link);
+        const raw = await fetchGoalRaw(host, link, goalId);
+        if (!raw) {
+            throw okrValidationError('not_found', `未查询到目标 ${goalId}，请确认目标 ID 是否正确或当前账号是否有查看权限`);
+        }
+        const session = await host.getSession();
+        const detailUrl = okrAbsoluteUrl(session.baseUrl, await resolver.resolve(goalId));
+        const goal = link === 'standard'
+            ? normalizeStandardGoal(raw, detailUrl, raw?.keyresultList)
+            : normalizeEbGoal(raw, detailUrl);
+        const notes = [];
+        let commentSummary = null;
+        if (link === 'standard' && args.include_comment_count !== false) {
+            const comment = await fetchCommentCount(host, goalId);
+            // 源资料：评论总条数为 0 时完全忽略评论模块，不输出任何评论相关文字。
+            if (!comment.unavailable && comment.totalCount !== null && comment.totalCount > 0) {
+                commentSummary = {
+                    totalCount: comment.totalCount,
+                    prompt: `该目标下共有${comment.totalCount}条评论，是否需要查看评论内容？`,
+                };
+            }
+            else if (comment.unavailable) {
+                notes.push('comment_count_unavailable');
+            }
+        }
+        else if (link === 'eb') {
+            notes.push('comment_api_unsupported_on_eb_link');
+        }
+        const data = {
+            status: 'COMPLETE',
+            link,
+            goalId,
+            goal,
+            ...(commentSummary ? { commentSummary } : {}),
+            raw,
+        };
+        return okrSuccess('okr.get', data, {
+            ...(notes.length > 0 ? { notes } : {}),
+            ...(resolver.warnings.length > 0 ? { warnings: resolver.warnings } : {}),
+        });
+    },
+};
+// ---------------------------------------------------------------------------
+// 分页查询目标关键成果（ebuilder 链路专属）
+// ---------------------------------------------------------------------------
+const okrKrList = {
+    name: 'okr.kr.list',
+    resource: 'okr',
+    method: 'kr.list',
+    action: 'okr.kr.list',
+    summary: '分页查询指定目标下的关键成果（仅 ebuilder 链路：okr_pageQueryGoalKeyResults）',
+    capability: 'okr',
+    risk: 'read',
+    inputSchema: schemaOf({
+        object_id: SCHEMA_ID,
+        page_no: { type: 'integer', minimum: 1, default: 1 },
+        page_size: { type: 'integer', minimum: 1, maximum: 100, default: 10 },
+    }, { required: ['object_id'] }),
+    handler: async (args, { host }) => {
+        const objectId = toIdString(args.object_id, 'object_id');
+        const { pageNo, pageSize } = pageOf(args);
+        const { link } = await resolveLink(host);
+        assertLinkSupported(link, 'eb', 'okr.kr.list', 'e10 标准版链路没有独立的关键成果分页接口，关键成果随目标列表/详情返回（okr.list 的 goals[].keyresultList、okr.get 的 goal.keyresultList）');
+        const session = await host.getSession();
+        const response = await host.request({
+            method: 'POST',
+            path: '/api/ebuilder/form/formdata/v2/getFormDataList/okr_pageQueryGoalKeyResults',
+            operation: 'okr.kr.list',
+            body: {
+                datajson: {
+                    mainTable: { object_id: objectId },
+                    pageInfo: { pageNo: String(pageNo), pageSize: String(pageSize) },
+                    header: { operator: session.userId },
+                },
+            },
+        });
+        if (!isDatajsonSuccess(response)) {
+            throw okrApiError('business_error', businessMessage(response), { response: businessMessage(response) });
+        }
+        const items = ebMainTables(response);
+        return okrSuccess('okr.kr.list', {
+            status: 'COMPLETE',
+            link,
+            objectId,
+            page: { pageNo, pageSize, count: items.length, hasNext: items.length === pageSize },
+            keyresults: items,
+        });
+    },
+};
+// ---------------------------------------------------------------------------
+// 分页查询目标评论（标准版链路专属）
+// ---------------------------------------------------------------------------
+const okrCommentList = {
+    name: 'okr.comment.list',
+    resource: 'okr',
+    method: 'comment.list',
+    action: 'okr.comment.list',
+    summary: '分页查询目标评论（仅标准版链路）；只有在用户明确要求查看评论内容后才可调用',
+    capability: 'okr',
+    risk: 'read',
+    inputSchema: schemaOf({
+        target_id: SCHEMA_ID,
+        page_no: { type: 'integer', minimum: 1, default: 1 },
+        page_size: { type: 'integer', minimum: 1, maximum: 100, default: 10 },
+    }, { required: ['target_id'] }),
+    handler: async (args, { host }) => {
+        const targetId = toIdString(args.target_id, 'target_id');
+        const { pageNo, pageSize } = pageOf(args);
+        const { link } = await resolveLink(host);
+        assertLinkSupported(link, 'standard', 'okr.comment.list', 'ebuilder 链路源资料未提供目标评论接口，无法查询评论内容');
+        const response = await host.request({
+            method: 'POST',
+            path: '/api/goal/common/comment/commentPage',
+            operation: 'okr.comment.list',
+            body: { pageNo, pageSize, targetId, module: 'goal', foldCommentList: false },
+        });
+        const page = response?.data?.page ?? {};
+        return okrSuccess('okr.comment.list', {
+            status: 'COMPLETE',
+            link,
+            targetId,
+            page: {
+                pageNo: page.pageNo ?? pageNo,
+                pageSize: page.pageSize ?? pageSize,
+                totalCount: page.totalCount ?? 0,
+                totalPages: page.totalPages ?? null,
+                hasNext: page.hasNext ?? false,
+            },
+            comments: Array.isArray(page.result) ? page.result : [],
+        });
+    },
+};
+// ---------------------------------------------------------------------------
+// 目标详情页链接（供无法拿到 ID 时直接取链接的快捷能力）
+// ---------------------------------------------------------------------------
+const okrDetailLink = {
+    name: 'okr.detail.link',
+    resource: 'okr',
+    method: 'detail.link',
+    action: 'okr.detail.link',
+    summary: '返回当前链路的目标详情页地址模板（标准版 /sp/goal/openDetail?id=目标id；eb 版 /sp/ebdfpage/card/0/表单id/目标id）',
+    capability: 'okr',
+    risk: 'read',
+    inputSchema: schemaOf({}),
+    handler: async (_args, { host }) => {
+        const { link } = await resolveLink(host);
+        const session = await host.getSession();
+        if (link === 'standard') {
+            return okrSuccess('okr.detail.link', {
+                link,
+                pathTemplate: buildStandardDetailPath('{goalId}'),
+                urlTemplate: okrAbsoluteUrl(session.baseUrl, buildStandardDetailPath('{goalId}')),
+                formId: null,
+            });
+        }
+        const info = await resolveEbFormId(host);
+        return okrSuccess('okr.detail.link', {
+            link,
+            pathTemplate: info.detailUrlTemplate,
+            urlTemplate: okrAbsoluteUrl(session.baseUrl, info.detailUrlTemplate),
+            formId: info.formId,
+            formIdSource: info.source,
+        });
+    },
+};
+export const okrReadOperations = [
+    okrVersionCheck,
+    okrEbFormResolve,
+    okrDetailLink,
+    okrViewlink,
+    okrList,
+    okrGet,
+    okrKrList,
+    okrCommentList,
+];

package/dist/shortcuts/okr/operations/registry.js

@@ -0,0 +1,31 @@
+import { okrValidationError } from '../errors.js';
+import { okrReadOperations } from './read.js';
+import { okrWriteOperations } from './write.js';
+function buildRegistry() {
+    const registry = new Map();
+    const definitions = [
+        ...okrReadOperations,
+        ...okrWriteOperations,
+    ];
+    for (const definition of definitions) {
+        if (registry.has(definition.name)) {
+            throw new Error(`duplicate okr operation: ${definition.name}`);
+        }
+        registry.set(definition.name, definition);
+    }
+    return registry;
+}
+const okrOperationRegistry = buildRegistry();
+export function okrOperationDefinitions() {
+    return [...okrOperationRegistry.values()];
+}
+export function getOkrOperation(operation) {
+    const definition = okrOperationRegistry.get(operation);
+    if (!definition) {
+        throw okrValidationError('operation_unknown', `OKR 目标模块不支持操作：${operation}`);
+    }
+    return definition;
+}
+export function hasOkrOperation(operation) {
+    return okrOperationRegistry.has(operation);
+}