Перейти к основному содержимому

signableEmptyBody

@mineflow/contracts


@mineflow/contracts / signableEmptyBody

Function: signableEmptyBody()

function signableEmptyBody(id: string, title: string): ZodObject<{
[key: string]: any;
_signature: ZodOptional<ZodObject<{
cms: ZodString;
format: ZodLiteral<"cms">;
}, $strip>>;
_signatures: ZodOptional<ZodArray<ZodObject<{
cms: ZodString;
format: ZodLiteral<"cms">;
}, $strip>>>;
}, $strip>;

Defined in: shared.ts:154

Стандартное «пустое подписываемое тело» для подписываемых роутов БЕЗ доменного тела (BL-58 / ADR-0105): withSignature(z.object({}).strict()) с заданными OpenAPI id/title. Убирает дублирование по множеству body-less подписываемых действий (prd.shift-report.approve, prd.block.accept, prd.production-plan.approve, …), сохраняя различные компоненты в спеке. Use-case тело игнорирует — _signature(s) снимает SignatureGuard до валидации.

Parameters​

ParameterType
idstring
titlestring

Returns​

ZodObject<{ [key: string]: any; _signature: ZodOptional<ZodObject<{ cms: ZodString; format: ZodLiteral<"cms">; }, $strip>>; _signatures: ZodOptional<ZodArray<ZodObject<{ cms: ZodString; format: ZodLiteral<"cms">; }, $strip>>>; }, $strip>

Example​

export const ApproveBodySchema = signableEmptyBody('ApproveX', 'Approve X body');
export class ApproveBodyDto extends createZodDto(ApproveBodySchema) {}