strapi-plugin-navigation 2.5.4 → 3.0.0-beta.0

package/types/services.d.ts

@@ -1,106 +0,0 @@
-import { Id, StrapiContentType, StrapiEvents, StrapiStore, StringMap } from "strapi-typed";
-import { NavigationPluginConfig } from "./config";
-import { Navigation, NavigationItem, NavigationItemCustomField, NavigationItemEntity, NavigationItemInput, NestedStructure, NotVoid, RelatedRef, RelatedRefBase } from "./contentTypes";
-import { I18nQueryParams } from "./i18n";
-import { AuditLogContext, ContentTypeEntity, Effect, NavigationActions, NavigationActionsPerItem, PopulateQueryParam, RenderType, RFRNavItem, ToBeFixed } from "./utils";
-import { ContentType } from "../server/utils";
-import { LifeCycleEvent, LifeCycleHookName } from "./lifecycle";
-export type NavigationServiceName = "common" | "admin" | "client";
-export type NavigationService = ICommonService | IAdminService | IClientService;
-export interface IAdminService {
-    config: (viaSettingsPage?: boolean) => Promise<NavigationPluginConfig>;
-    get: (ids?: Array<number>, ignoreLocale?: boolean) => Promise<Navigation[]>;
-    getById: (id: Id) => Promise<Navigation>;
-    post: (payload: ToBeFixed, auditLog: AuditLogContext) => ToBeFixed;
-    put: (id: Id, payload: ToBeFixed, auditLog: AuditLogContext) => ToBeFixed;
-    delete: (id: Id, auditLog: AuditLogContext) => Promise<void>;
-    restart: () => Promise<void>;
-    restoreConfig: () => Promise<void>;
-    updateConfig: (newConfig: NavigationPluginConfig) => Promise<void>;
-    fillFromOtherLocale(payload: {
-        source: number;
-        target: number;
-        auditLog: AuditLogContext;
-    }): Promise<Navigation>;
-    readNavigationItemFromLocale(payload: {
-        source: number;
-        target: number;
-        path: string;
-    }): Promise<Partial<Pick<NotVoid<Navigation['items']>[number], 'path' | 'related' | 'type' | 'uiRouterKey' | 'title' | 'externalPath'>>>;
-    purgeNavigationsCache: () => Promise<{
-        success: boolean;
-    }>;
-    purgeNavigationCache: (id: Id, clearLocalisations?: boolean) => Promise<{
-        success: boolean;
-    }>;
-}
-export interface ICommonService {
-    analyzeBranch: (items: NestedStructure<NavigationItem>[], masterEntity: Navigation | null, parentItem?: ToBeFixed, prevOperations?: NavigationActions) => Promise<NavigationActionsPerItem[]>;
-    configContentTypes: (viaSettingsPage?: boolean) => Promise<StrapiContentType<ToBeFixed>[]>;
-    createBranch: (items: NestedStructure<NavigationItemInput | NavigationItem>[], masterEntity: Navigation | null, parentItem: NavigationItemEntity | null, operations: NavigationActions) => ToBeFixed;
-    emitEvent: (uid: string, event: StrapiEvents, entity: ToBeFixed) => Promise<void>;
-    getBranchName: (item: NavigationItem) => keyof NavigationActionsPerItem | void;
-    getContentTypeItems: (uid: string, query: StringMap<string>) => Promise<ContentTypeEntity[]>;
-    getIdsRelated: (relatedItems: RelatedRefBase[] | RelatedRef[] | null, master: number) => Promise<Id[] | void>;
-    getPluginStore: () => Promise<StrapiStore>;
-    getRelatedItems: (entityItems: NavigationItemEntity[], populate?: PopulateQueryParam) => Promise<NavigationItemEntity<ContentTypeEntity>[]>;
-    pruneCustomFields: (removedFields: NavigationItemCustomField[]) => Promise<void>;
-    removeBranch: (items: NestedStructure<NavigationItem>[], operations: NavigationActions) => ToBeFixed;
-    removeRelated: (relatedItems: RelatedRef[], master: number) => ToBeFixed;
-    setDefaultConfig: () => Promise<NavigationPluginConfig>;
-    updateBranch: (toUpdate: NestedStructure<NavigationItem>[], masterEntity: Navigation | null, parentItem: NavigationItemEntity | null, operations: NavigationActions) => ToBeFixed;
-    getSlug(query: string): Promise<string>;
-    registerLifecycleHook(input: {
-        hookName: LifeCycleHookName;
-        callback: Effect<LifeCycleEvent>;
-        contentTypeName: ContentType;
-    }): void;
-    runLifecycleHook(input: {
-        hookName: LifeCycleHookName;
-        event: LifeCycleEvent;
-        contentTypeName: ContentType;
-    }): Promise<void>;
-}
-export interface IClientService {
-    readAll: (input: {
-        orderBy?: string;
-        orderDirection?: string;
-    } & I18nQueryParams) => Promise<ToBeFixed>;
-    render: (input: {
-        idOrSlug: Id;
-        type?: RenderType;
-        menuOnly?: boolean;
-        rootPath?: string;
-        wrapRelated?: boolean;
-        populate?: PopulateQueryParam;
-    } & I18nQueryParams) => Promise<ToBeFixed>;
-    renderChildren: (input: {
-        idOrSlug: Id;
-        childUIKey: string;
-        type?: RenderType;
-        menuOnly?: boolean;
-        wrapRelated?: boolean;
-    } & I18nQueryParams) => Promise<ToBeFixed>;
-    renderRFR: (input: {
-        items: NestedStructure<NavigationItem>[];
-        parent?: Id | null;
-        parentNavItem?: RFRNavItem | null;
-        contentTypes: string[];
-        enabledCustomFieldsNames: string[];
-    }) => ToBeFixed;
-    renderRFRNav: (item: NavigationItem) => RFRNavItem;
-    renderRFRPage: (item: NavigationItem & {
-        related: ToBeFixed;
-    }, parent: Id | null, enabledCustomFieldsNames: string[]) => ToBeFixed;
-    renderTree(items: NavigationItemEntity<ContentTypeEntity>[], id: Id | null, field: keyof NavigationItemEntity, path: string | undefined, itemParser: ToBeFixed): ToBeFixed;
-    renderType: (input: {
-        type: RenderType;
-        criteria: ToBeFixed;
-        itemCriteria: ToBeFixed;
-        filter: ToBeFixed;
-        rootPath: string | null;
-        wrapRelated?: boolean;
-        populate?: PopulateQueryParam;
-    } & I18nQueryParams) => ToBeFixed;
-}
-//# sourceMappingURL=services.d.ts.map

package/types/services.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=services.js.map

package/types/utils.d.ts

@@ -1,72 +0,0 @@
-import { Id, PopulateClause } from "strapi-typed";
-import { Navigation, NavigationItem, NavigationItemType, NestedStructure } from "./contentTypes";
-export type Effect<T> = (value: T) => void;
-export type VoidEffect = Effect<void>;
-export type NavigationActionsCategories = 'toCreate' | 'toUpdate' | 'toRemove';
-export type RenderTypeOptions = Readonly<{
-    FLAT: 'FLAT';
-    TREE: 'TREE';
-    RFR: 'RFR';
-}>;
-export type RenderType = keyof RenderTypeOptions;
-export type StrapiRoutesTypes = 'admin' | 'content-api';
-export type ToBeFixed = any;
-export type DateString = string;
-export type PopulateQueryParam = string | PopulateClause;
-export type PluginPermissions = {
-    canAccess: boolean;
-    canUpdate?: boolean;
-    canUpdateSettings?: boolean;
-};
-export type NavigationActions = {
-    create?: boolean;
-    update?: boolean;
-    remove?: boolean;
-};
-export type NavigationActionsPerItem = Record<NavigationActionsCategories, NestedStructure<NavigationItem>[]>;
-export type AuditLogContext = any;
-export type AuditLogParams = {
-    actionType: string;
-    oldEntity: Navigation;
-    newEntity: Navigation;
-} | {
-    actionType: "DELETE";
-    entity: Navigation;
-};
-export type ContentTypeEntity = {
-    id: Id;
-} & Record<string, unknown>;
-export type NestedPath = {
-    id: Id;
-    parent?: {
-        id: Id;
-        path: string;
-    };
-    path: string;
-};
-export type RFRNavItem = {
-    label?: string;
-    type: NavigationItemType;
-    page?: string;
-    url?: string;
-    audience?: string[];
-};
-export type StrapiRoute = {
-    method: string;
-    path: string;
-    handler: string;
-    config?: ToBeFixed;
-};
-export type StrapiRoutes = {
-    type: StrapiRoutesTypes;
-    routes: StrapiRoute[];
-};
-export type StrapiControllerContext = any;
-export type StrapiControllerContextParams = any;
-export declare const assertNotEmpty: <T>(value: T | null | undefined, customError?: Error) => asserts value is T;
-export declare const isNumber: (x: unknown) => boolean;
-export declare const assertIsNumber: (n: unknown, customError?: Error) => asserts n is number;
-export declare const assertEntity: <T>(entity: unknown, name?: string) => T;
-export declare function assertBoolean(value: unknown): asserts value is boolean;
-export declare function assertString(value: unknown): asserts value is string;
-//# sourceMappingURL=utils.d.ts.map

package/types/utils.js

@@ -1,41 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertString = exports.assertBoolean = exports.assertEntity = exports.assertIsNumber = exports.isNumber = exports.assertNotEmpty = void 0;
-const assertNotEmpty = (value, customError) => {
-    if (value !== undefined && value !== null) {
-        return;
-    }
-    throw customError ?? new Error("Non-empty value expected, empty given");
-};
-exports.assertNotEmpty = assertNotEmpty;
-const isNumber = (x) => typeof x === "number" && !Number.isNaN(x);
-exports.isNumber = isNumber;
-const assertIsNumber = (n, customError) => {
-    if ((0, exports.isNumber)(n)) {
-        return;
-    }
-    throw customError ?? new Error(`Number is expected. "${typeof n}" given`);
-};
-exports.assertIsNumber = assertIsNumber;
-const assertEntity = (entity, name = "Entity") => {
-    if (entity instanceof Object && entity.hasOwnProperty("id")) {
-        return entity;
-    }
-    throw new Error(`${name} instance expected. ${typeof entity} given.`);
-};
-exports.assertEntity = assertEntity;
-function assertBoolean(value) {
-    if (typeof value === "boolean") {
-        return;
-    }
-    throw new Error("Value is not of type boolean");
-}
-exports.assertBoolean = assertBoolean;
-function assertString(value) {
-    if (typeof value === "string") {
-        return;
-    }
-    throw new Error("Value is not of type string");
-}
-exports.assertString = assertString;
-//# sourceMappingURL=utils.js.map

package/utils/InvalidParamNavigationError.d.ts

@@ -1,4 +0,0 @@
-export class InvalidParamNavigationError extends NavigationError {
-}
-import { NavigationError } from "./NavigationError";
-//# sourceMappingURL=InvalidParamNavigationError.d.ts.map

package/utils/InvalidParamNavigationError.js

@@ -1,8 +0,0 @@
-"use strict";
-const { NavigationError } = require("./NavigationError");
-class InvalidParamNavigationError extends NavigationError {
-}
-module.exports = {
-    InvalidParamNavigationError,
-};
-//# sourceMappingURL=InvalidParamNavigationError.js.map

package/utils/NavigationError.d.ts

@@ -1,5 +0,0 @@
-export class NavigationError extends Error {
-    constructor(message: any, additionalInfo: any);
-    additionalInfo: any;
-}
-//# sourceMappingURL=NavigationError.d.ts.map

package/utils/NavigationError.js

@@ -1,11 +0,0 @@
-"use strict";
-class NavigationError extends Error {
-    constructor(message, additionalInfo) {
-        super(message);
-        this.additionalInfo = additionalInfo;
-    }
-}
-module.exports = {
-    NavigationError,
-};
-//# sourceMappingURL=NavigationError.js.map