strapi-plugin-navigation/dist/server/src/services/index.d.ts

Strapi - Navigation plugin

export type { AdminService } from './admin';
export type { ClientService } from './client';
export type { CommonService } from './common';
export type { MigrationService } from './migration';
declare const _default: {
    admin: (context: {
        strapi: import("@strapi/types/dist/core").Strapi;
    }) => {
        config({ viaSettingsPage }: import("./admin/types").ConfigInput): Promise<import("../dtos").NavigationPluginConfigDTO>;
        configContentTypes({ viaSettingsPage, }: import("./admin/types").ConfigInput): Promise<import("../dtos").ConfigContentTypeDTO[]>;
        get({ ids, locale }: import("./admin/types").GetInput): Promise<{
            name: string;
            id: number;
            documentId: string;
            slug: string;
            locale: string;
            visible: boolean;
            items?: import("../schemas").NavigationItemDBSchema[] | undefined;
        }[]>;
        getById({ documentId, locale, populate }: import("./admin/types").GetByIdInput): Promise<{
            name: string;
            id: number;
            documentId: string;
            slug: string;
            locale: string;
            visible: boolean;
            items?: import("../schemas").NavigationItemDBSchema[] | undefined;
        }>;
        post({ auditLog, payload }: import("./admin/types").PostInput): Promise<import("../dtos").NavigationDTO>;
        put({ auditLog, payload }: import("./admin/types").PutInput): Promise<{
            name: string;
            id: number;
            documentId: string;
            slug: string;
            locale: string;
            visible: boolean;
            items?: import("../schemas").NavigationItemDBSchema[] | undefined;
        }>;
        delete({ auditLog, documentId }: import("./admin/types").DeleteInput): Promise<void>;
        restart(): Promise<void>;
        restoreConfig(): Promise<void>;
        updateConfig({ config: newConfig }: import("./admin/types").UpdateConfigInput): Promise<void>;
        fillFromOtherLocale({ auditLog, source, target, documentId, }: import("./admin/types").FillFromOtherLocaleInput): Promise<{
            name: string;
            id: number;
            documentId: string;
            slug: string;
            locale: string;
            visible: boolean;
            items?: import("../schemas").NavigationItemDBSchema[] | undefined;
        }>;
        i18nNavigationContentsCopy({ source, target, }: import("./admin/types").I18nNavigationContentsCopyInput): Promise<void>;
        readNavigationItemFromLocale({ path, source, target, }: import("./admin/types").ReadNavigationItemFromLocaleInput): Promise<{
            type: "INTERNAL" | "EXTERNAL" | "WRAPPER";
            title: string;
            uiRouterKey: string;
            path?: string | null | undefined;
            externalPath?: string | null | undefined;
            related?: unknown;
        }>;
        getContentTypeItems({ query, uid, }: import("./admin/types").GetContentTypeItemsInput): Promise<{
            documentId: string;
        }[]>;
        purgeNavigationCache(documentId: string, clearLocalisations?: boolean | undefined): Promise<{
            success: boolean;
        }>;
        purgeNavigationsCache(): Promise<{
            success: boolean;
        }>;
    };
    common: (context: {
        strapi: import("@strapi/types/dist/core").Strapi;
    }) => {
        getPluginStore(): Promise<{
            get(params?: Partial<{
                key: string;
                type?: string | undefined;
                environment?: string | undefined;
                name?: string | undefined;
                tag?: string | undefined;
            }> | undefined): Promise<unknown>;
            set(params?: Partial<{
                key: string;
                value: unknown;
                type?: string | undefined;
                environment?: string | undefined;
                name?: string | undefined;
                tag?: string | undefined;
            }> | undefined): Promise<void>;
            delete(params?: Partial<{
                key: string;
                type?: string | undefined;
                environment?: string | undefined;
                name?: string | undefined;
                tag?: string | undefined;
            }> | undefined): Promise<void>;
        }>;
        mapToNavigationItemDTO({ locale, master, navigationItems, parent, populate, }: import("./common/types").MapToNavigationItemDTOInput): Promise<import("../dtos").NavigationItemDTO[]>;
        setDefaultConfig(): Promise<{
            additionalFields: ("audience" | {
                type: "string" | "boolean";
                name: string;
                label: string;
                options?: string[] | undefined;
                required?: boolean | undefined;
                enabled?: boolean | undefined;
                multi?: false | undefined;
            } | {
                type: "media";
                name: string;
                label: string;
                options?: string[] | undefined;
                required?: boolean | undefined;
                enabled?: boolean | undefined;
                multi?: false | undefined;
            } | {
                options: string[];
                type: "select";
                name: string;
                label: string;
                multi: boolean;
                required?: boolean | undefined;
                enabled?: boolean | undefined;
            })[];
            allowedLevels: number;
            contentTypes: string[];
            contentTypesNameFields: Record<string, string[]>;
            contentTypesPopulate: Record<string, string[]>;
            gql: {
                navigationItemRelated: string[];
            };
            pathDefaultFields: Record<string, any>;
            cascadeMenuAttached: boolean;
            preferCustomContentTypes: boolean;
            isCacheEnabled?: boolean | undefined;
        }>;
        getBranchName({ item }: import("./common/types").GetBranchNameInput): void | import("../types").NavigationActionsCategories;
        analyzeBranch({ masterEntity, navigationItems, parentItem, prevAction, }: import("./common/types").AnalyzeBranchInput): Promise<import("../types").NavigationAction[]>;
        removeBranch({ navigationItems, action, }: import("./common/types").RemoveBranchInput): Promise<import("../types").NavigationAction[]>;
        createBranch({ action, masterEntity, navigationItems, parentItem, }: import("./common/types").CreateBranchInput): Promise<import("../types").NavigationAction[]>;
        updateBranch({ masterEntity, navigationItems, action, parentItem, }: import("./common/types").UpdateBranchInput): Promise<import("../types").NavigationAction[]>;
        emitEvent({ entity, event, uid }: import("./common/types").EmitEventInput<any, any>): Promise<void>;
        pruneCustomFields({ removedFields }: {
            removedFields: ({
                type: "string" | "boolean";
                name: string;
                label: string;
                options?: string[] | undefined;
                required?: boolean | undefined;
                enabled?: boolean | undefined;
                multi?: false | undefined;
            } | {
                type: "media";
                name: string;
                label: string;
                options?: string[] | undefined;
                required?: boolean | undefined;
                enabled?: boolean | undefined;
                multi?: false | undefined;
            } | {
                options: string[];
                type: "select";
                name: string;
                label: string;
                multi: boolean;
                required?: boolean | undefined;
                enabled?: boolean | undefined;
            })[];
        }): Promise<void>;
        getSlug({ query }: import("./common/types").GetSlugInput): Promise<string>;
        registerLifeCycleHook({ callback, contentTypeName, hookName }: import("./common/types").RegisterLifeCycleHookInput): void;
        runLifeCycleHook({ contentTypeName, event, hookName }: import("./common/types").RunLifeCycleHookInput): Promise<void>;
        buildNestedStructure({ navigationItems, id, }: import("./common/types").BuildNestedStructureInput): import("../schemas").NavigationItemDBSchema[];
        readLocale(): Promise<{
            defaultLocale: string;
            restLocale: string[];
        }>;
    };
    client: (context: {
        strapi: import("@strapi/types/dist/core").Strapi;
    }) => {
        readAll({ locale, orderBy, orderDirection }: import("./client/types").ReadAllInput): Promise<{
            name: string;
            id: number;
            documentId: string;
            slug: string;
            locale: string;
            visible: boolean;
            items?: import("../schemas").NavigationItemDBSchema[] | undefined;
        }[]>;
        renderRFRNavigationItem({ item }: import("./client/types").RenderRFRNavInput): import("../dtos").RFRNavigationItemDTO;
        renderRFRPage({ item, parent, enabledCustomFieldsNames }: import("./client/types").RenderRFRPageInput): import("../dtos").RFRPageDTO;
        renderRFR({ items, parent, parentNavItem, contentTypes, enabledCustomFieldsNames, }: import("./client/types").RenderRFRInput): {
            pages: {};
            nav: {};
        };
        renderTree({ items, documentId, path, itemParser, }: import("./client/types").RenderTreeInput): Promise<import("../dtos").NavigationItemDTO[]>;
        getCustomFields(additionalFields: ("audience" | {
            type: "string" | "boolean";
            name: string;
            label: string;
            options?: string[] | undefined;
            required?: boolean | undefined;
            enabled?: boolean | undefined;
            multi?: false | undefined;
        } | {
            type: "media";
            name: string;
            label: string;
            options?: string[] | undefined;
            required?: boolean | undefined;
            enabled?: boolean | undefined;
            multi?: false | undefined;
        } | {
            options: string[];
            type: "select";
            name: string;
            label: string;
            multi: boolean;
            required?: boolean | undefined;
            enabled?: boolean | undefined;
        })[]): ({
            type: "string" | "boolean";
            name: string;
            label: string;
            options?: string[] | undefined;
            required?: boolean | undefined;
            enabled?: boolean | undefined;
            multi?: false | undefined;
        } | {
            type: "media";
            name: string;
            label: string;
            options?: string[] | undefined;
            required?: boolean | undefined;
            enabled?: boolean | undefined;
            multi?: false | undefined;
        } | {
            options: string[];
            type: "select";
            name: string;
            label: string;
            multi: boolean;
            required?: boolean | undefined;
            enabled?: boolean | undefined;
        })[];
        renderType({ criteria, filter, itemCriteria, locale, populate, rootPath, type, wrapRelated, }: import("./client/types").RenderTypeInput): Promise<import("../dtos").NavigationItemDTO[] | {
            pages: {};
            nav: {};
        } | {
            audience: string[] | undefined;
            title: string;
            related: any;
            items: null;
            additionalFields: {};
            path?: string | null | undefined;
            type: "INTERNAL" | "EXTERNAL" | "WRAPPER";
            id: number;
            documentId: string;
            slug?: string | null | undefined;
            externalPath?: string | null | undefined;
            uiRouterKey: string;
            menuAttached: boolean;
            order: number;
            collapsed: boolean;
            autoSync?: boolean | null | undefined;
            master?: import("../dtos").NavigationDTO | undefined;
            parent?: import("../dtos").NavigationItemDTO | null | undefined;
        }[]>;
        renderChildren({ childUIKey, idOrSlug, locale, menuOnly, type, wrapRelated, }: import("./client/types").RenderChildrenInput): Promise<import("../dtos").NavigationItemDTO[] | {
            pages: {};
            nav: {};
        } | {
            audience: string[] | undefined;
            title: string;
            related: any;
            items: null;
            additionalFields: {};
            path?: string | null | undefined;
            type: "INTERNAL" | "EXTERNAL" | "WRAPPER";
            id: number;
            documentId: string;
            slug?: string | null | undefined;
            externalPath?: string | null | undefined;
            uiRouterKey: string;
            menuAttached: boolean;
            order: number;
            collapsed: boolean;
            autoSync?: boolean | null | undefined;
            master?: import("../dtos").NavigationDTO | undefined;
            parent?: import("../dtos").NavigationItemDTO | null | undefined;
        }[]>;
        render({ idOrSlug, locale, menuOnly, populate, rootPath, type, wrapRelated, }: import("./client/types").RenderInput): Promise<import("../dtos").NavigationItemDTO[] | {
            pages: {};
            nav: {};
        } | {
            audience: string[] | undefined;
            title: string;
            related: any;
            items: null;
            additionalFields: {};
            path?: string | null | undefined;
            type: "INTERNAL" | "EXTERNAL" | "WRAPPER";
            id: number;
            documentId: string;
            slug?: string | null | undefined;
            externalPath?: string | null | undefined;
            uiRouterKey: string;
            menuAttached: boolean;
            order: number;
            collapsed: boolean;
            autoSync?: boolean | null | undefined;
            master?: import("../dtos").NavigationDTO | undefined;
            parent?: import("../dtos").NavigationItemDTO | null | undefined;
        }[]>;
    };
    migrate: (context: {
        strapi: import("@strapi/types/dist/core").Strapi;
    }) => {
        migrateRelatedIdToDocumentId(): Promise<void>;
    };
};
export default _default;