@adcp/sdk API Reference - v14.0.0-beta.6
    Preparing search index...

    Interface CompileUniversalMacroTemplateInput

    interface CompileUniversalMacroTemplateInput {
        template: string;
        source_dialect: string;
        source_syntaxes: readonly SourceMacroSyntaxDeclaration[];
        mappings: readonly SourceMacroMapping[];
        require_documentation?: boolean;
        allow_canonical_macros?: boolean;
        satisfied_requirements?: readonly SourceMacroRequirementSatisfaction[];
    }
    Index

    Properties

    template source_dialect source_syntaxes mappings require_documentation? allow_canonical_macros? satisfied_requirements?

    Properties

    template: string
    source_dialect: string
    source_syntaxes: readonly SourceMacroSyntaxDeclaration[]

    Syntaxes the selected dialect uses. Unknown-token scanning is limited to this list so ordinary URL, JavaScript, and template syntax is not guessed to be a macro. Every configured mapping must match one declared built-in or custom syntax.

    mappings: readonly SourceMacroMapping[]
    require_documentation?: boolean

    Fail mappings without documentation provenance. Defaults to true.

    allow_canonical_macros?: boolean

    Preserve supported {ADCP_MACRO} tokens without a mapping. Defaults to false because a vendor dialect can use the same spelling with a different meaning. Enable only when the input is known to contain canonical AdCP.

    satisfied_requirements?: readonly SourceMacroRequirementSatisfaction[]

    Attestations for mapping requirements satisfied before publication.

    Settings

    Member Visibility

    On This Page

    Properties