Function toStructuredEnvelope

src/utils/structured-output-envelope.ts:382–408

(
  result: TResult,
  schema: string,
  schemaVersion: string,
  options: StructuredEnvelopeOptions = {},
)

}

export function toStructuredEnvelope<TResult extends ToolDomainResult>(
  result: TResult,
  schema: string,
  schemaVersion: string,
  options: StructuredEnvelopeOptions = {},
): StructuredOutputEnvelope<unknown> {
  const { nextSteps, nextStepRuntime = 'cli', outputStyle = 'normal' } = options;
  const { kind: neverKind, didError, error, ...data } = result;
  const projectedData = projectRuntimeSnapshotData(data as DomainResultData<TResult>, options);
  const serializedNextSteps =
    schema === 'xcodebuildmcp.output.error'
      ? undefined
      : serializeNextSteps(nextSteps, {
          runtime: nextStepRuntime,
        });

  const envelope: StructuredOutputEnvelope<unknown> = {
    schema,
    schemaVersion,
    didError,
    error,
    data: isRecord(projectedData) && Object.keys(projectedData).length === 0 ? null : projectedData,
    ...(serializedNextSteps ? { nextSteps: serializedNextSteps } : {}),
  };

  return applyStructuredOutputStyle(envelope, outputStyle);
}