NAME

Developer::Dashboard::Codec - payload encoding helpers for Developer Dashboard

SYNOPSIS

use Developer::Dashboard::Codec qw(encode_payload decode_payload);
my $token = encode_payload($text);
my $text  = decode_payload($token);

DESCRIPTION

This module provides the compact payload transport used by Developer Dashboard for transient page and action tokens.

FUNCTIONS

encode_payload

Compress and base64-encode a text payload.

decode_payload

Decode and inflate a token back to text.

PURPOSE

Perl module in the Developer Dashboard codebase. This file wraps the project encoding and decoding helpers used across runtime data flows. Open this file when you need the implementation, regression coverage, or runtime entrypoint for that responsibility rather than guessing which part of the tree owns it.

WHY IT EXISTS

It exists to keep this responsibility in reusable Perl code instead of hiding it in the thin dashboard switchboard, bookmark text, or duplicated helper scripts. That separation makes the runtime easier to test, safer to change, and easier for contributors to navigate.

WHEN TO USE

Use this file when you are changing the underlying runtime behaviour it owns, when you need to call its routines from another part of the project, or when a failing test points at this module as the real owner of the bug.

HOW TO USE

Load Developer::Dashboard::Codec from Perl code under lib/ or from a focused test, then use the public routines documented in the inline function comments and existing SYNOPSIS/METHODS sections. This file is not a standalone executable.

WHAT USES IT

This file is used by whichever runtime path owns this responsibility: the public dashboard entrypoint, staged private helper scripts under share/private-cli/, the web runtime, update flows, and the focused regression tests under t/.

EXAMPLES

perl -Ilib -MDeveloper::Dashboard::Codec -e 'print qq{loaded\n}'

That example is only a quick load check. For real usage, follow the public routines already described in the inline code comments and any existing SYNOPSIS section.