@terminalfour/terminalfour-js 1.0.0-rc.1

package/dist/esm/resources/navigation-resource.d.ts

@@ -0,0 +1,664 @@
+import { HttpClient } from '../http-client.js';
+/** SDK-friendly navigation type codes (consistent kebab-case) */
+export type NavigationType = 'a-to-z' | 'breadcrumbs' | 'css-selector' | 'generate-file' | 'keyword-search' | 'language-switcher' | 'link-menu' | 'pagination' | 'previous-next-fulltext' | 'publish-to-one-file' | 'related-content' | 'related-section-branch' | 'return-to-index' | 'section-details' | 'section-iterator' | 'section-meta-info' | 'site-map' | 'top-content' | 'top-stories';
+/** Human-readable type name mapping */
+export declare const NAVIGATION_TYPE_NAMES: Record<NavigationType, string>;
+/** Summary returned from list() */
+export interface NavigationSummary {
+    id: number;
+    name: string;
+    description: string;
+    type: NavigationType;
+    typeName: string;
+    enabled: boolean;
+}
+/** Raw API response shape from GET /navigation/{id} */
+interface RawNavigationDetail {
+    id: number;
+    name: string;
+    description?: string;
+    navigationType: string;
+    navigationTypeName?: string;
+    isEnabled: boolean;
+    isPreviewModeEnabled: boolean;
+    isCachingEnabled: boolean;
+    date?: string;
+    properties: Record<string, {
+        value?: string;
+        attribute: string;
+        navigationPropertyID: number;
+    }>;
+    [key: string]: unknown;
+}
+/**
+ * A mutable navigation object. Modify properties and call save() to persist.
+ */
+export declare class NavigationObject {
+    readonly id: number;
+    name: string;
+    description: string;
+    readonly type: NavigationType;
+    readonly typeName: string;
+    enabled: boolean;
+    cachingEnabled: boolean;
+    previewEnabled: boolean;
+    properties: Record<string, unknown>;
+    private readonly _httpClient;
+    private _rawData;
+    private _originalPropertyKeys;
+    constructor(raw: RawNavigationDetail, httpClient: HttpClient);
+    /** Persists current property values to the server via PUT. */
+    save(): Promise<void>;
+}
+/** Properties for A to Z Navigation create */
+export interface A2ZProperties {
+    /** Level to start generating from. 0 = root. Defaults to 0. */
+    startLevel?: number;
+    /** Level to stop generating at. 0 = all sections. Defaults to 0. */
+    endLevel?: number;
+    /** Whether to use section meta data element for display. Defaults to false. */
+    useSectionMetaData?: boolean;
+    /** Element name on the Section Meta Data content type to display. Only valid when useSectionMetaData is true. Defaults to ''. */
+    sectionMetaContentTypeElement?: string;
+    /** Microsite ID to scope the navigation to, or null for no microsite. Defaults to null. */
+    microSite?: number | null;
+    /** HTML before the menu. Defaults to ''. */
+    beforeMenu?: string;
+    /** HTML after the menu. Defaults to ''. */
+    afterMenu?: string;
+    /** HTML before each item. Defaults to ''. */
+    beforeItem?: string;
+    /** HTML after each item. Defaults to ''. */
+    afterItem?: string;
+}
+/** Properties for Breadcrumbs create */
+export interface BreadcrumbsProperties {
+    /** Level to start from. 0 = root. Defaults to 0. Must be >= 0. */
+    startLevel?: number;
+    /** Level to end at. 0 = all. Defaults to 0. Must be >= 0. */
+    endLevel?: number;
+    /** Whether breadcrumb items are links. Defaults to false. */
+    useLinks?: boolean;
+    /** Whether the current (last) item is a link. Defaults to false. */
+    linkCurrent?: boolean;
+    /** Whether to hide the home section from the breadcrumb trail. Defaults to false. */
+    hideHome?: boolean;
+    /** Whether to remove spaces from links. Only valid when useLinks is true. Defaults to false. */
+    noSpace?: boolean;
+    /** Maximum number of characters before truncation. 0 = no limit. Defaults to 0. Must be >= 0. */
+    maxLength?: number;
+    /** HTML separator between breadcrumb items. Defaults to ''. */
+    separator?: string;
+    /** Content element name to append to the breadcrumb trail. If set, enables content element appending. Defaults to ''. */
+    elementToAppend?: string;
+    /** HTML before the breadcrumb. Defaults to ''. */
+    beforeHtml?: string;
+    /** HTML after the breadcrumb. Defaults to ''. */
+    afterHtml?: string;
+}
+/** A branch override for CSS Selector */
+export interface CssSelectorBranch {
+    /** Media ID of the stylesheet for this branch. Required. */
+    stylesheet: number;
+    /** Section name to match for this branch. Cannot be combined with rootSection. */
+    name?: string;
+    /** Section ID to use as root for this branch. Cannot be combined with name. */
+    rootSection?: number;
+}
+/** Properties for CSS Selector create */
+export interface CssSelectorProperties {
+    /** Media ID of the default stylesheet. Required. */
+    defaultStylesheet: number;
+    /** Language code. Optional, defaults to ''. */
+    language?: string;
+    /** Branch-specific stylesheet overrides. Optional. */
+    branches?: CssSelectorBranch[];
+}
+/** Properties for Generate File create */
+export interface GenerateFileProperties {
+    /** Output file name. Optional, defaults to ''. */
+    fileName?: string;
+    /** Whether to append the content ID to the file name. Defaults to false. */
+    appendContentId?: boolean;
+    /** File extension for the generated file. Optional, defaults to ''. */
+    fileExtension?: string;
+    /** Base directory for output. Optional, defaults to ''. */
+    baseDirectory?: string;
+    /** Content layout name to use. Optional, defaults to ''. */
+    layout?: string;
+    /** Whether to append the directory path. Defaults to false. */
+    appendDirectory?: boolean;
+    /** Media ID to associate with the generated file. Optional. Validated if provided. */
+    mediaFile?: number | null;
+}
+/** Properties for Language Switcher create */
+export interface LanguageSwitcherProperties {
+    /** Language code. Optional, defaults to ''. */
+    langCode?: string;
+    /** Whether to always output the switcher even when only one language exists. Defaults to false. */
+    alwaysOutput?: boolean;
+    /** URL for image-based language links. Optional, defaults to ''. */
+    imageUrl?: string;
+    /** File extension for language images (e.g. '.gif'). Optional, defaults to ''. */
+    imageExtension?: string;
+    /** HTML attributes for language images (e.g. 'width="30" height="30"'). Optional, defaults to ''. */
+    imageProperties?: string;
+    /** HTML before the switcher. Optional, defaults to ''. */
+    beforeHtml?: string;
+    /** HTML after the switcher. Optional, defaults to ''. */
+    afterHtml?: string;
+}
+/** Fetch method options for Pagination */
+export type PaginationFetchMethod = 'current' | 'current-branch' | 'branch' | 'branch-at-level' | 'section';
+/** Properties for Pagination create */
+export interface PaginationProperties {
+    /** Content Type ID to paginate. Required, validated. */
+    contentTypeId: number;
+    /** Fetch method. Defaults to 'current'. */
+    fetchMethod?: PaginationFetchMethod;
+    /** Section ID (required for 'branch', 'branch-at-level', 'section'). Validated. */
+    section?: number;
+    /** Level for 'branch-at-level'. Defaults to 0. */
+    level?: number;
+    /** Recursion depth for 'current-branch', 'branch', 'branch-at-level'. Defaults to 0. */
+    numToRecurse?: number;
+    /** Number of content items per page. Defaults to 0 (no pagination). */
+    contentItemsPerPage?: number;
+    /** Maximum total content items. Defaults to 0 (unlimited). */
+    maxContentItems?: number;
+    /** Maximum pagination links to show. Defaults to 0 (all). */
+    maxLinksPerPage?: number;
+    /** Alternative layout name. If set, validates against content type layouts. Defaults to ''. */
+    altLayoutName?: string;
+    /** Whether to search hidden sections. Defaults to false. */
+    searchHiddenSections?: boolean;
+    /** HTML before the content. Defaults to ''. */
+    beforeHtml?: string;
+    /** HTML after the content. Defaults to ''. */
+    afterHtml?: string;
+    /** HTML before pagination links. Defaults to ''. */
+    beforePaginationHtml?: string;
+    /** HTML after pagination links. Defaults to ''. */
+    afterPaginationHtml?: string;
+    /** HTML between pagination links. Defaults to ''. */
+    betweenPaginationHtml?: string;
+}
+/** Direction type for Previous/Next Fulltext Content */
+export type PreviousNextType = 'previous' | 'next' | 'both';
+/** Properties for Previous/Next Fulltext Content create */
+export interface PreviousNextProperties {
+    /** Which direction links to show. Defaults to 'previous'. */
+    type?: PreviousNextType;
+    /** Alternative layout name. If set, enables custom formatter. Defaults to ''. */
+    altLayoutName?: string;
+    /** Whether to skip content that doesn't have fulltext. Defaults to false. */
+    skipNonFulltextContent?: boolean;
+    /** Whether to only link to content that also has a prev/next navigation. Defaults to false. */
+    onlyLinkToContentWithNav?: boolean;
+    /** Whether to restrict to content of the same content type. Defaults to false. */
+    sameContentTypeRestriction?: boolean;
+    /** Whether to display links on boundaries (first/last item). Defaults to false. */
+    displayOnBoundary?: boolean;
+    /** Whether to display content name as the link title. Defaults to false. */
+    displayContentNameAsTitle?: boolean;
+    /** HTML for the previous link. Defaults to ''. */
+    previousHtml?: string;
+    /** HTML between previous and next links. Defaults to ''. */
+    betweenHtml?: string;
+    /** HTML for the next link. Defaults to ''. */
+    nextHtml?: string;
+}
+/** Properties for Section Iterator create */
+export interface SectionIteratorProperties {
+    /** HTML before the iterator output. Defaults to ''. */
+    beforeHtml?: string;
+    /** HTML between each iterated section. Defaults to ''. */
+    betweenHtml?: string;
+    /** HTML after the iterator output. Defaults to ''. */
+    afterHtml?: string;
+}
+/** Properties for Related Section Branch create */
+export interface RelatedSectionBranchProperties {
+    /** Name of the child section to link to. Defaults to ''. */
+    childSectionName?: string;
+    /** Link text to display. Defaults to ''. */
+    linkText?: string;
+}
+/** Properties for Return to Index create */
+export interface ReturnToIndexProperties {
+    /** Link text. Defaults to ''. */
+    linkText?: string;
+    /** Whether to append the section name to the link text. Defaults to false. */
+    appendSectionName?: boolean;
+    /** Whether to scroll to the content on click. Defaults to false. */
+    scrollToContent?: boolean;
+    /** Link target attribute (e.g. '_blank'). Defaults to ''. */
+    linkTarget?: string;
+}
+/** Properties for Section Meta Info create */
+export interface SectionMetaInfoProperties {
+    /** Meta tag name (e.g. 'description', 'og:title'). Required. Validated against GET /meta/level. */
+    metaType: string;
+    /** Date format string (e.g. 'dd.MM.yyyy'). Optional, defaults to ''. */
+    dateFormat?: string;
+    /** HTML before the meta output. Optional, defaults to ''. */
+    beforeHtml?: string;
+    /** HTML after the meta output. Optional, defaults to ''. */
+    afterHtml?: string;
+}
+/** Properties for Top Stories create */
+export interface TopStoriesProperties {
+    /** Section ID to pull top stories from. Required, validated. */
+    section: number;
+    /** Number of items to show. 0 = all. Defaults to 0. */
+    numToShow?: number;
+    /** Whether to link items to their fulltext page. Defaults to false. */
+    linkToFulltext?: boolean;
+    /** Title text. Defaults to ''. */
+    title?: string;
+    /** HTML before the menu. Defaults to ''. */
+    beforeMenuHtml?: string;
+    /** HTML after the menu. Defaults to ''. */
+    afterMenuHtml?: string;
+    /** HTML before each item. Defaults to ''. */
+    beforeHtml?: string;
+    /** HTML after each item. Defaults to ''. */
+    afterHtml?: string;
+}
+/** Properties for Site Map create */
+export interface SiteMapProperties {
+    /** Section ID to start from. 0 = channel root. Optional, validated if non-zero. Defaults to 0. */
+    startSection?: number;
+    /** Number of levels to display. 0 = all. Defaults to 0. */
+    levels?: number;
+    /** Whether to show links to child sections. Defaults to false. */
+    childSectionLinks?: boolean;
+    /** Whether to enable content counting. Defaults to false. */
+    enableContentCount?: boolean;
+    /** Content Type IDs to count. Empty array or omitted = all types. Only valid when enableContentCount is true. Validated. */
+    contentTypeIds?: number[];
+    /** Maximum levels to recurse when counting. Only valid when enableContentCount is true. Defaults to ''. */
+    maxLevelsToCount?: number | string;
+    /** Whether to count content recursively through child sections. Only valid when enableContentCount is true. Defaults to false. */
+    countRecursively?: boolean;
+    /** HTML before the content count. Only valid when enableContentCount is true. Defaults to ''. */
+    htmlBeforeContentCount?: string;
+    /** HTML after the content count. Only valid when enableContentCount is true. Defaults to ''. */
+    htmlAfterContentCount?: string;
+}
+/** Detail method for Section Details */
+export type SectionDetailMethod = 'current' | 'level' | 'section';
+/** Display type for Section Details */
+export type SectionDetailDisplayType = 'id' | 'name' | 'path' | 'link';
+/** Properties for Section Details create */
+export interface SectionDetailsProperties {
+    /** How to determine which section to display details for. Defaults to 'current'. */
+    detailMethod?: SectionDetailMethod;
+    /** Level to use when detailMethod is 'level'. Defaults to 0. */
+    level?: number;
+    /** Section ID when detailMethod is 'section'. Required and validated when method is 'section'. */
+    section?: number;
+    /** What to display about the section. Defaults to 'id'. */
+    displayType?: SectionDetailDisplayType;
+}
+/** Fetch method for Related Content */
+export type RelatedContentFetchMethod = 'current' | 'section' | 'child';
+/** Properties for Related Content create */
+export interface RelatedContentProperties {
+    /** Fetch method. Defaults to 'current'. */
+    fetchMethod?: RelatedContentFetchMethod;
+    /** Section ID (required for 'section' method). Validated. */
+    section?: number;
+    /** Child section name to search in (for 'child' method). Optional. */
+    childSectionName?: string;
+    /** Content Type IDs to filter by (required for 'child' method). Validated. */
+    contentTypeIds?: number[];
+    /** Number of items to display. 0 = all. Defaults to 0. */
+    display?: number;
+    /** Whether to recurse into child sections (for 'child' method). Defaults to false. */
+    recurseChildSection?: boolean;
+    /** Alternative layout name. If set, enables alt formatter. Defaults to ''. */
+    altLayoutName?: string;
+    /** Title text. Defaults to ''. */
+    title?: string;
+    /** HTML before the content. Defaults to ''. */
+    beforeHtml?: string;
+    /** HTML after the content. Defaults to ''. */
+    afterHtml?: string;
+}
+/** Menu type for Link Menu */
+export type LinkMenuType = 'branch-at-level' | 'children' | 'siblings' | 'siblings-and-children';
+/** Menu display type for Link Menu */
+export type LinkMenuDisplayType = 'normal' | 'dropdown';
+/** Link display type for Link Menu */
+export type LinkDisplayType = 'ul' | 'table' | 'div';
+/** Properties for Link Menu create */
+export interface LinkMenuProperties {
+    /** Menu type. Required. */
+    menuType: LinkMenuType;
+    /** Menu display type. Defaults to 'normal'. */
+    menuDisplayType?: LinkMenuDisplayType;
+    /** Level (only for 'branch-at-level'). Defaults to 0. */
+    level?: number;
+    /** Recursion depth (only for 'branch-at-level'). Defaults to 1. */
+    numToRecurse?: number;
+    /** Link display type (only when branch-at-level + numToRecurse>1, or siblings-and-children). */
+    subNavigationType?: LinkDisplayType;
+    /** Whether to show non-current children. Defaults to false. */
+    showNonCurrentChildren?: boolean;
+    /** Whether to add a CSS class to the current branch. Defaults to false. */
+    useCurrentBranchClass?: boolean;
+    /** Whether to make the current section a link. Defaults to false. */
+    currentSectionLink?: boolean;
+    /** Whether to prepend section name to the title. Defaults to false. */
+    addSectionName?: boolean;
+    /** Whether to display a specific branch (only for 'children'). Defaults to false. */
+    displaySpecificBranch?: boolean;
+    /** Section ID of the specific branch (only when displaySpecificBranch is true). Validated. */
+    specificBranchId?: number;
+    /** Whether to show siblings if no children (only for 'children'). Defaults to false. */
+    showSiblingsIfNoChildren?: boolean;
+    /** Whether to show ancestors if no children (only for 'children'). Defaults to false. */
+    showAncestorsIfNoChildren?: boolean;
+    /** Title text. Defaults to ''. */
+    title?: string;
+    /** HTML before the menu. Defaults to ''. */
+    beforeMenuHtml?: string;
+    /** HTML after the menu. Defaults to ''. */
+    afterMenuHtml?: string;
+    /** HTML before each link. Defaults to ''. */
+    beforeLinkHtml?: string;
+    /** HTML after each link. Defaults to ''. */
+    afterLinkHtml?: string;
+    /** HTML between links. Defaults to ''. */
+    betweenLink?: string;
+}
+/** Start section mode for Publish to One File */
+export type PublishOneFileStartSection = 'current' | 'specific' | 'element';
+/** Properties for Publish to One File create */
+export interface PublishToOneFileProperties {
+    /** Content Type ID to filter by. null = all content types. Validated if provided. */
+    contentTypeId?: number | null;
+    /** Start section mode. Defaults to 'current'. */
+    startSection?: PublishOneFileStartSection;
+    /** Section ID (only for 'specific' mode). Required and validated. */
+    section?: number;
+    /** Element name to derive section from (only for 'element' mode). Free text. */
+    startSectionElement?: string;
+    /** Whether to include hidden sections. Defaults to false. */
+    showHiddenSections?: boolean;
+    /** Number of levels to recurse. Defaults to 1. */
+    levelsToRecurse?: number;
+    /** HTML before content. Defaults to ''. */
+    beforeHtml?: string;
+    /** HTML after content. Defaults to ''. */
+    afterHtml?: string;
+    /** Whether to display section names in output. Defaults to false. */
+    showSectionName?: boolean;
+    /** Whether to show section name for hidden sections (only when showSectionName is true). Defaults to false. */
+    showNameForHidden?: boolean;
+    /** HTML before section name (only when showSectionName is true). Defaults to ''. */
+    beforeSectionName?: string;
+    /** HTML after section name (only when showSectionName is true). Defaults to ''. */
+    afterSectionName?: string;
+    /** Page Layout ID to wrap output in. Optional, validated if provided. */
+    surroundingPageLayout?: number;
+    /** Alternative content layout name. If set, enables alt formatter. Defaults to ''. */
+    altLayoutName?: string;
+    /** Whether to enable caching. Defaults to true. */
+    enableCaching?: boolean;
+    /** Whether to paginate output across pages. Defaults to false. */
+    pagination?: boolean;
+    /** Content items per page (only when pagination is true). Defaults to 0. */
+    contentPerPage?: number;
+    /** HTML before pagination (only when pagination is true). Defaults to ''. */
+    beforePaginationHtml?: string;
+    /** HTML between pagination links (only when pagination is true). Defaults to ''. */
+    betweenPaginationHtml?: string;
+    /** HTML after pagination (only when pagination is true). Defaults to ''. */
+    afterPaginationHtml?: string;
+}
+/** Fetch method for Top Content */
+export type TopContentFetchMethod = 'current' | 'current-branch' | 'branch' | 'section';
+/** Properties for Top Content create */
+export interface TopContentProperties {
+    /** Fetch method. Defaults to 'current'. */
+    fetchMethod?: TopContentFetchMethod;
+    /** Section ID (required for 'branch' and 'section'). Validated. */
+    section?: number;
+    /** Content Type IDs to filter by. Empty = all. Validated. */
+    contentTypeIds?: number[];
+    /** Channel ID to restrict to. 0 = no restriction. Validated if non-zero. */
+    channelId?: number;
+    /** Whether to show upcoming/future content instead of current. Defaults to false. */
+    upcomingContent?: boolean;
+    /** Date element name for ordering/filtering. Defaults to ''. */
+    dateElement?: string;
+    /** Whether to ignore date ordering and use T4's section order. Defaults to false. */
+    ignoreDateOrdering?: boolean;
+    /** Number of content items to display. 0 = all. Defaults to 0. */
+    numToDisplay?: number;
+    /** Number of content items to skip. Defaults to 0. */
+    startAt?: number;
+    /** Alternative content layout name. If set, enables alt formatter. Defaults to ''. */
+    altLayoutName?: string;
+    /** Title text. Defaults to ''. */
+    title?: string;
+    /** HTML before the content. Defaults to ''. */
+    beforeHtml?: string;
+    /** HTML after the content. Defaults to ''. */
+    afterHtml?: string;
+}
+/** Keyword fetch method for Keyword Search Content */
+export type KeywordFetchMethod = 'current' | 'parent' | 'section';
+/** Content fetch method for Keyword Search Content */
+export type KeywordContentFetchMethod = 'section' | 'branch' | 'branch-at-level';
+/** Sort type for Keyword Search Content */
+export type KeywordSortType = 'name' | 'name-desc' | 'last-modified';
+/** Properties for Keyword Search Content create */
+export interface KeywordSearchProperties {
+    /** Keyword fetch method. Defaults to 'current'. */
+    keywordFetchMethod?: KeywordFetchMethod;
+    /** Section ID for keyword retrieval (required when keywordFetchMethod is 'section'). Validated. */
+    keywordSection?: number;
+    /** Whether to narrow keyword selection to single content item. Defaults to false. */
+    narrowToSingleContentItem?: boolean;
+    /** Content Type ID for keyword retrieval. null = any content type. Validated if provided. */
+    keywordContentTypeId?: number | null;
+    /** Element names to get keywords from. Array. */
+    keywordElements?: string[];
+    /** Content fetch method. Defaults to 'section'. */
+    contentFetchMethod?: KeywordContentFetchMethod;
+    /** Section ID to search in (for section/branch, when not using searchSectionElement). Validated. */
+    searchSection?: number;
+    /** Content element name to derive search section from (alternative to searchSection). */
+    searchSectionElement?: string;
+    /** Start level (only for 'branch-at-level'). Defaults to 0. */
+    startLevel?: number;
+    /** End level / recursion depth (only for 'branch-at-level'). Defaults to 0. */
+    endLevel?: number;
+    /** Content Type ID to search keywords in. null = any content type. Validated if provided. */
+    searchContentTypeId?: number | null;
+    /** Element names to search keywords in. Array. */
+    searchElements?: string[];
+    /** Number of content items to display. Defaults to 0 (all). */
+    numToDisplay?: number;
+    /** Sort type. Defaults to 'name'. */
+    sortType?: KeywordSortType;
+    /** Whether to sort by a date element. Defaults to false. */
+    sortByDateElement?: boolean;
+    /** Date element name (only when sortByDateElement is true). */
+    dateElementName?: string;
+    /** Whether to show upcoming/future content. Defaults to false. */
+    showUpcomingContent?: boolean;
+    /** Whether to include hidden sections. Defaults to false. */
+    showHiddenSections?: boolean;
+    /** Whether to match composite keywords. Defaults to false. */
+    matchCompositeKeywords?: boolean;
+    /** Whether to match sub-items. Defaults to false. */
+    matchSubItems?: boolean;
+    /** Whether to enable cross-language searching. Defaults to false. */
+    crossLanguageSearch?: boolean;
+    /** Language codes for cross-language searching. Array. */
+    crossLanguageLanguages?: string[];
+    /** Alternative content layout name. Defaults to ''. */
+    altLayoutName?: string;
+    /** HTML before content. Defaults to ''. */
+    beforeHtml?: string;
+    /** HTML after content. Defaults to ''. */
+    afterHtml?: string;
+    /** Whether to enable pagination. Defaults to false. */
+    pagination?: boolean;
+    /** Content items per page (only when pagination is true). Defaults to 0. */
+    contentPerPage?: number;
+    /** HTML before pagination. Defaults to ''. */
+    beforePaginationHtml?: string;
+    /** HTML between pagination links. Defaults to ''. */
+    betweenPaginationHtml?: string;
+    /** HTML after pagination. Defaults to ''. */
+    afterPaginationHtml?: string;
+}
+/** Create data shape — type determines which properties are valid */
+export interface CreateNavigationData {
+    type: NavigationType;
+    name: string;
+    description?: string;
+    enabled?: boolean;
+    previewEnabled?: boolean;
+    properties?: A2ZProperties | BreadcrumbsProperties | CssSelectorProperties | GenerateFileProperties | LanguageSwitcherProperties | PaginationProperties | PreviousNextProperties | SectionIteratorProperties | RelatedSectionBranchProperties | ReturnToIndexProperties | SectionMetaInfoProperties | TopStoriesProperties | SiteMapProperties | SectionDetailsProperties | RelatedContentProperties | LinkMenuProperties | PublishToOneFileProperties | TopContentProperties | KeywordSearchProperties | Record<string, unknown>;
+}
+/**
+ * Data for updating a navigation object (immutable pattern).
+ * `type` is omitted — a navigation object's type cannot be changed after creation.
+ * `properties` is merged into the existing properties.
+ */
+export interface UpdateNavigationData {
+    name?: string;
+    description?: string;
+    enabled?: boolean;
+    previewEnabled?: boolean;
+    cachingEnabled?: boolean;
+    properties?: A2ZProperties | BreadcrumbsProperties | CssSelectorProperties | GenerateFileProperties | LanguageSwitcherProperties | PaginationProperties | PreviousNextProperties | SectionIteratorProperties | RelatedSectionBranchProperties | ReturnToIndexProperties | SectionMetaInfoProperties | TopStoriesProperties | SiteMapProperties | SectionDetailsProperties | RelatedContentProperties | LinkMenuProperties | PublishToOneFileProperties | TopContentProperties | KeywordSearchProperties | Record<string, unknown>;
+}
+/**
+ * Resource for navigation object operations.
+ * Accessible via `t4.navigation`.
+ */
+export declare class NavigationResource {
+    private readonly httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Lists all navigation objects.
+     * Optionally filter by type.
+     */
+    list(options?: {
+        type?: NavigationType;
+    }): Promise<NavigationSummary[]>;
+    /** Gets a single navigation object by ID. Returns a mutable NavigationObject. */
+    get(id: number): Promise<NavigationObject>;
+    /** Post-construction async resolution — resolves IDs to names and raw element names to aliases. */
+    private resolveNavigationProperties;
+    /** Creates a new navigation object. */
+    create(data: CreateNavigationData): Promise<NavigationObject>;
+    /**
+     * Updates a navigation object's properties (immutable pattern).
+     * Fetches the existing object, applies your changes, saves, and returns it.
+     *
+     * `properties` is merged into the existing properties — pass only the keys you
+     * want to change. Everything else is preserved. The navigation `type` cannot be
+     * changed after creation.
+     */
+    update(id: number, data: UpdateNavigationData): Promise<NavigationObject>;
+    /** Deletes a navigation object by ID. */
+    delete(id: number): Promise<void>;
+    /** Returns the default caching value per type (some types always use false). */
+    private getDefaultCaching;
+    /** Builds and validates properties for the given navigation type. */
+    private buildProperties;
+    /** Builds properties for A to Z Navigation with validation. */
+    private buildA2ZProperties;
+    /** Builds properties for Breadcrumbs with validation. */
+    private buildBreadcrumbsProperties;
+    /** Builds properties for Section Iterator. */
+    private buildSectionIteratorProperties;
+    /** Builds properties for Related Section Branch. */
+    private buildRelatedSectionBranchProperties;
+    /** Builds properties for Return to Index. */
+    private buildReturnToIndexProperties;
+    /** Builds properties for Section Meta Info with meta type validation. */
+    private buildSectionMetaInfoProperties;
+    /** Fetches meta tag level definitions from GET /meta/level. */
+    private getMetaLevels;
+    /** Builds properties for Section Details with validation. */
+    private buildSectionDetailsProperties;
+    /** Builds properties for Link Menu with validation. */
+    private buildLinkMenuProperties;
+    /** Builds properties for Publish to One File with validation. */
+    private buildPublishToOneFileProperties;
+    /** Builds properties for Top Content with validation. */
+    private buildTopContentProperties;
+    /** Builds properties for Keyword Search Content with validation. */
+    private buildKeywordSearchProperties;
+    /** Fetches content type elements. */
+    private getContentTypeElements;
+    /** Resolves an element type name (e.g. 'Plain Text', 'Section/Content Link') to its numeric ID via GET /type/. */
+    private getElementTypeId;
+    /**
+     * Validates an element alias exists on a content type and returns the raw name.
+     * Developer passes alias → SDK sends raw name to API.
+     */
+    private resolveElementAliasToName;
+    /**
+     * Resolves multiple element aliases to raw names.
+     */
+    private resolveElementAliasesToNames;
+    /**
+     * Resolves raw element names back to aliases for display.
+     * API stores raw name → SDK returns alias to developer.
+     */
+    private resolveElementNamesToAliases;
+    /**
+     * Resolves a single raw element name back to its alias.
+     */
+    private resolveElementNameToAlias;
+    /** Validates that an element name exists on a content type (legacy — used by searchSectionElement validation in builder). */
+    private validateElementOnContentType;
+    /** Validates that a channel exists by ID. */
+    private validateChannelExists;
+    /** Validates that a page layout exists by ID. */
+    private validatePageLayoutExists;
+    /** Builds properties for Related Content with validation. */
+    private buildRelatedContentProperties;
+    /** Builds properties for Top Stories with section validation. */
+    private buildTopStoriesProperties;
+    /** Builds properties for Previous/Next Fulltext Content. */
+    private buildPreviousNextProperties;
+    /** Builds properties for Pagination with validation. */
+    private buildPaginationProperties;
+    /** Builds properties for Site Map with validation. */
+    private buildSiteMapProperties;
+    /** Validates that a content type exists by ID. */
+    private validateContentTypeExists;
+    /** Validates that a layout name exists on a content type. */
+    private validateLayoutOnContentType;
+    /** Builds properties for Language Switcher. */
+    private buildLanguageSwitcherProperties;
+    /** Builds properties for Generate File with validation. */
+    private buildGenerateFileProperties;
+    /** Builds properties for CSS Selector with validation. */
+    private buildCssSelectorProperties;
+    /** Validates that a media item exists by ID. */
+    private validateMediaExists;
+    /** Validates that a section exists by ID. */
+    private validateSectionExists;
+    /** Passes properties through without type-specific validation. */
+    private buildGenericProperties;
+    /** Resolves a meta data element alias to its raw name. Returns the raw name for the API. Only Plain Text elements are valid. */
+    private resolveMetaDataElementAlias;
+    /** Resolves a raw meta data element name back to its alias for display. */
+    private resolveMetaDataElementName;
+    /** Validates that a microsite ID exists. */
+    private validateMicrositeId;
+}
+export {};
+//# sourceMappingURL=navigation-resource.d.ts.map