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

package/server/services/common/common.js

@@ -1,307 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("@strapi/utils");
-const slugify_1 = __importDefault(require("@sindresorhus/slugify"));
-const lodash_1 = require("lodash");
-const config_1 = require("../../config");
-const repositories_1 = require("../../repositories");
-const schemas_1 = require("../../schemas");
-const utils_2 = require("../../utils");
-const utils_3 = require("./utils");
-const lifecycleHookListeners = {
-    navigation: {},
-    'navigation-item': {},
-};
-const commonService = (context) => ({
-    async getPluginStore() {
-        return await strapi.store({ type: 'plugin', name: 'navigation' });
-    },
-    async mapToNavigationItemDTO({ navigationItems, populate, master, parent, }) {
-        const entities = new Map();
-        const result = [];
-        const pluginStore = await this.getPluginStore();
-        const config = schemas_1.configSchema.parse(await pluginStore.get({ key: 'config' }));
-        for (const navigationItem of navigationItems) {
-            const { related, items = [], master: _, parent: __, ...base } = navigationItem;
-            if (!related) {
-                result.push({
-                    ...base,
-                    items: [],
-                    related: undefined,
-                    master,
-                    parent,
-                });
-            }
-            if (related && !entities.has(related)) {
-                const [uid, id] = related.split(utils_2.RELATED_ITEM_SEPARATOR);
-                entities.set(related, {
-                    ...(await (0, repositories_1.getGenericRepository)(context, uid).findById(parseInt(id, 10), (0, lodash_1.isNil)(populate) ? config.contentTypesPopulate[uid] || [] : (0, utils_2.parsePopulateQuery)(populate))),
-                    uid,
-                });
-            }
-            const preItem = {
-                ...base,
-                related: related ? entities.get(related) : undefined,
-                master,
-                parent,
-                items: [],
-            };
-            result.push({
-                ...preItem,
-                items: await this.mapToNavigationItemDTO({
-                    navigationItems: items,
-                    populate,
-                    master,
-                    parent: preItem,
-                }),
-            });
-        }
-        return result;
-    },
-    setDefaultConfig() {
-        return (0, config_1.configSetup)({ strapi });
-    },
-    getBranchName({ item }) {
-        const hasId = !!item.id;
-        const toRemove = item.removed;
-        if (hasId && !toRemove) {
-            return 'toUpdate';
-        }
-        if (hasId && toRemove) {
-            return 'toRemove';
-        }
-        if (!hasId && !toRemove) {
-            return 'toCreate';
-        }
-    },
-    async analyzeBranch({ masterEntity, navigationItems = [], parentItem, prevAction = {}, }) {
-        const { toCreate, toRemove, toUpdate } = navigationItems.reduce((acc, navigationItem) => {
-            const branchName = this.getBranchName({
-                item: navigationItem,
-            });
-            return branchName ? { ...acc, [branchName]: [...acc[branchName], navigationItem] } : acc;
-        }, {
-            toRemove: [],
-            toCreate: [],
-            toUpdate: [],
-        });
-        const action = {
-            create: prevAction.create || toCreate.length > 0,
-            update: prevAction.update || toUpdate.length > 0,
-            remove: prevAction.remove || toRemove.length > 0,
-        };
-        const checkData = [...toCreate, ...toUpdate];
-        await (0, utils_3.checkDuplicatePath)({
-            checkData,
-            parentItem,
-        });
-        return Promise.all([
-            this.createBranch({
-                action,
-                masterEntity,
-                navigationItems: toCreate,
-                parentItem,
-            }),
-            this.removeBranch({
-                navigationItems: toRemove,
-                action,
-            }),
-            this.updateBranch({
-                action,
-                masterEntity,
-                navigationItems: toUpdate,
-                parentItem,
-            }),
-        ]).then(([a, b, c]) => [...a, ...b, ...c]);
-    },
-    async removeBranch({ navigationItems = [], action = {}, }) {
-        const navigationActions = [];
-        for (const navigationItem of navigationItems) {
-            if (!navigationItem.id) {
-                continue;
-            }
-            action.remove = true;
-            await (0, repositories_1.getNavigationItemRepository)(context).remove(navigationItem);
-            navigationActions.push(action);
-            if (!!navigationItem.items?.length) {
-                const innerResult = await this.removeBranch({
-                    navigationItems: navigationItem.items,
-                });
-                innerResult.forEach((_) => {
-                    navigationActions.push(_);
-                });
-            }
-        }
-        return navigationActions;
-    },
-    async createBranch({ action, masterEntity, navigationItems, parentItem, }) {
-        let navigationActions = [];
-        for (const navigationItem of navigationItems) {
-            action.create = true;
-            const { parent, master, items, id, ...params } = navigationItem;
-            const insertDetails = id
-                ? {
-                    ...params,
-                    id,
-                    master: masterEntity ? masterEntity.id : undefined,
-                    parent: parentItem ? parentItem.id : undefined,
-                }
-                : {
-                    ...params,
-                    id: undefined,
-                    master: masterEntity ? masterEntity.id : undefined,
-                    parent: parentItem ? parentItem.id : undefined,
-                };
-            const nextParentItem = await (0, repositories_1.getNavigationItemRepository)(context).save(insertDetails);
-            if (!!navigationItem.items?.length) {
-                const innerActions = await this.createBranch({
-                    action: {},
-                    masterEntity,
-                    navigationItems: navigationItem.items,
-                    parentItem: nextParentItem,
-                });
-                navigationActions = navigationActions.concat(innerActions).concat([action]);
-            }
-            else {
-                navigationActions.push(action);
-            }
-        }
-        return navigationActions;
-    },
-    async updateBranch({ masterEntity, navigationItems, action, parentItem, }) {
-        const result = [];
-        for (const updateDetails of navigationItems) {
-            action.update = true;
-            const { id, updated, parent, master, items, ...params } = updateDetails;
-            let currentItem;
-            if (updated) {
-                currentItem = await (0, repositories_1.getNavigationItemRepository)(context).save({
-                    id,
-                    ...params,
-                });
-            }
-            else {
-                currentItem = updateDetails;
-            }
-            if (!!items?.length) {
-                const innerResult = await this.analyzeBranch({
-                    navigationItems: items,
-                    prevAction: {},
-                    masterEntity,
-                    parentItem: currentItem,
-                });
-                innerResult.forEach((_) => {
-                    result.push(_);
-                });
-            }
-            else {
-                result.push(action);
-            }
-        }
-        return result;
-    },
-    async emitEvent({ entity, event, uid }) {
-        // TODO: This could be enhanced by reacting not only with webhook but by firing all listeners in Navigation Event Hub
-        // Any developer could register new listener for any event in Navigation Plugin
-        // For now there is only one event 'navigation.update' so implementing Event hub is not valid.
-        const model = strapi.getModel(uid);
-        const sanitizedEntity = await utils_1.sanitize.sanitizers.defaultSanitizeOutput({
-            ...model,
-            schema: model.__schema__,
-            getModel: () => model,
-        }, entity);
-        if (strapi.webhookRunner) {
-            strapi.webhookRunner.eventHub.emit(event, {
-                model: model.modelName,
-                entry: sanitizedEntity,
-            });
-        }
-        else {
-            console.warn('Webhook runner not present. Contact with Strapi Navigation Plugin team.');
-        }
-    },
-    async pruneCustomFields({ removedFields }) {
-        const removedFieldsKeys = removedFields.map(({ name }) => `additionalFields.${name}`);
-        const removedFieldsNames = removedFields.map(({ name }) => name);
-        const navigationItems = await (0, repositories_1.getNavigationItemRepository)(context).find({
-            where: {
-                additionalFields: {
-                    $contains: [removedFieldsNames],
-                },
-            },
-        });
-        const navigationItemsToUpdate = navigationItems.map((navigationItem) => (0, lodash_1.omit)(navigationItem, removedFieldsKeys));
-        for (const item of navigationItemsToUpdate) {
-            await (0, repositories_1.getNavigationItemRepository)(context).save({
-                id: item.id,
-                additionalFields: item.additionalFields,
-            });
-        }
-    },
-    async getSlug({ query }) {
-        let slug = (0, slugify_1.default)(query);
-        if (slug) {
-            const existingItems = await (0, repositories_1.getNavigationItemRepository)(context).count({
-                $or: [
-                    {
-                        uiRouterKey: {
-                            $startsWith: slug,
-                        },
-                    },
-                    { uiRouterKey: slug },
-                ],
-            });
-            if (existingItems) {
-                slug = `${slug}-${existingItems}`;
-            }
-        }
-        return slug.toLowerCase();
-    },
-    registerLifeCycleHook({ callback, contentTypeName, hookName }) {
-        if (!lifecycleHookListeners[contentTypeName][hookName]) {
-            lifecycleHookListeners[contentTypeName][hookName] = [];
-        }
-        lifecycleHookListeners[contentTypeName][hookName]?.push(callback);
-    },
-    async runLifeCycleHook({ contentTypeName, event, hookName }) {
-        const hookListeners = lifecycleHookListeners[contentTypeName][hookName] ?? [];
-        for (const listener of hookListeners) {
-            await listener(event);
-        }
-    },
-    buildNestedStructure({ navigationItems, id, }) {
-        return (navigationItems?.reduce((acc, navigationItem) => {
-            if (id && navigationItem.parent?.id !== id) {
-                return acc;
-            }
-            acc.push({
-                ...(0, lodash_1.omit)(navigationItem, ['related', 'items']),
-                related: navigationItem.related,
-                items: this.buildNestedStructure({
-                    navigationItems,
-                    id: navigationItem.id,
-                }),
-            });
-            return acc;
-        }, []) ?? []);
-    },
-    async readLocale() {
-        const localeService = strapi.plugin('i18n').service('locales');
-        let defaultLocale = await localeService.getDefaultLocale();
-        let restLocale = (await localeService.find({}))
-            .map(({ code }) => code)
-            .filter((code) => code !== defaultLocale);
-        if (!defaultLocale) {
-            defaultLocale = restLocale[0];
-            restLocale = restLocale.slice(1);
-        }
-        return {
-            defaultLocale,
-            restLocale,
-        };
-    },
-});
-exports.default = commonService;

package/server/services/common/index.js

@@ -1,7 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const common_1 = __importDefault(require("./common"));
-exports.default = common_1.default;

package/server/services/common/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/server/services/common/utils.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkDuplicatePath = void 0;
-const app_errors_1 = require("../../app-errors");
-const checkDuplicatePath = ({ checkData, parentItem, }) => {
-    return new Promise((resolve, reject) => {
-        if (parentItem && parentItem.items) {
-            for (let item of checkData) {
-                for (let _ of parentItem.items) {
-                    if (_.path === item.path && _.id !== item.id && item.type === 'INTERNAL') {
-                        return reject(new app_errors_1.NavigationError(`Duplicate path:${item.path} in parent: ${parentItem.title || 'root'} for ${item.title} and ${_.title} items`, {
-                            parentTitle: parentItem.title,
-                            parentId: parentItem.id,
-                            path: item.path,
-                            errorTitles: [item.title, _.title],
-                        }));
-                    }
-                }
-            }
-        }
-        return resolve();
-    });
-};
-exports.checkDuplicatePath = checkDuplicatePath;

package/server/services/index.js

@@ -1,13 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const admin_1 = __importDefault(require("./admin"));
-const client_1 = __importDefault(require("./client"));
-const common_1 = __importDefault(require("./common"));
-exports.default = {
-    admin: admin_1.default,
-    common: common_1.default,
-    client: client_1.default,
-};

package/server/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/server/utils/constants.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TEMPLATE_DEFAULT = exports.DEFAULT_POPULATE = exports.KIND_TYPES = exports.CONTENT_TYPES_NAME_FIELDS_DEFAULTS = exports.RESTRICTED_CONTENT_TYPES = exports.ALLOWED_CONTENT_TYPES = exports.RELATED_ITEM_SEPARATOR = exports.allLifecycleHooks = exports.UID_REGEX = void 0;
-exports.UID_REGEX = /^(?<type>[a-z0-9-]+)\:{2}(?<api>[a-z0-9-]+)\.{1}(?<contentType>[a-z0-9-]+)$/i;
-exports.allLifecycleHooks = [
-    'beforeCreate',
-    'beforeCreateMany',
-    'afterCreate',
-    'afterCreateMany',
-    'beforeUpdate',
-    'beforeUpdateMany',
-    'afterUpdate',
-    'afterUpdateMany',
-    'beforeDelete',
-    'beforeDeleteMany',
-    'afterDelete',
-    'afterDeleteMany',
-    'beforeCount',
-    'afterCount',
-    'beforeFindOne',
-    'afterFindOne',
-    'beforeFindMany',
-    'afterFindMany',
-];
-exports.RELATED_ITEM_SEPARATOR = '$';
-exports.ALLOWED_CONTENT_TYPES = ['api::', 'plugin::'];
-exports.RESTRICTED_CONTENT_TYPES = [
-    'plugin::users-permissions',
-    'plugin::i18n.locale',
-    'plugin::navigation',
-];
-exports.CONTENT_TYPES_NAME_FIELDS_DEFAULTS = ['title', 'subject', 'name'];
-exports.KIND_TYPES = { SINGLE: 'singleType', COLLECTION: 'collectionType' };
-exports.DEFAULT_POPULATE = [];
-exports.TEMPLATE_DEFAULT = 'Generic';

package/server/utils/functions.js

@@ -1,111 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.singularize = exports.isContentTypeEligible = exports.parsePopulateQuery = exports.getPluginService = exports.getPluginModels = exports.buildAllHookListeners = exports.buildHookListener = exports.assertConfig = exports.resolveGlobalLikeId = exports.assertNotEmpty = exports.validateAdditionalFields = exports.getCustomFields = void 0;
-const lodash_1 = require("lodash");
-const schemas_1 = require("../schemas");
-const constants_1 = require("./constants");
-const getCustomFields = (additionalFields) => additionalFields.filter((field) => field !== 'audience');
-exports.getCustomFields = getCustomFields;
-const validateAdditionalFields = (additionalFields) => {
-    const forbiddenNames = [
-        'title',
-        'type',
-        'path',
-        'externalPath',
-        'uiRouterKey',
-        'menuAttached',
-        'order',
-        'collapsed',
-        'related',
-        'parent',
-        'master',
-        'audience',
-        'additionalFields',
-    ];
-    const customFields = (0, exports.getCustomFields)(additionalFields);
-    if (customFields.length !== (0, lodash_1.uniqBy)(customFields, 'name').length) {
-        throw new Error('All names of custom fields must be unique.');
-    }
-    if (!(0, lodash_1.isNil)((0, lodash_1.find)(customFields, (field) => typeof field === 'object' && (0, lodash_1.includes)(forbiddenNames, field.name)))) {
-        throw new Error(`Name of custom field cannot be one of: ${forbiddenNames.join(', ')}`);
-    }
-};
-exports.validateAdditionalFields = validateAdditionalFields;
-const assertNotEmpty = (value, customError) => {
-    if (value !== undefined && value !== null) {
-        return;
-    }
-    throw customError ?? new Error('Non-empty value expected, empty given');
-};
-exports.assertNotEmpty = assertNotEmpty;
-const resolveGlobalLikeId = (uid = '') => {
-    const parse = (str) => str
-        .split('-')
-        .map((_) => (0, lodash_1.capitalize)(_))
-        .join('');
-    const [type, scope, contentTypeName] = splitTypeUid(uid);
-    if (type === 'api') {
-        return parse(contentTypeName);
-    }
-    return `${parse(scope)}${parse(contentTypeName)}`;
-};
-exports.resolveGlobalLikeId = resolveGlobalLikeId;
-const splitTypeUid = (uid = '') => {
-    return uid.split(constants_1.UID_REGEX).filter((s) => s && s.length > 0);
-};
-function assertConfig(config) {
-    if (schemas_1.configSchema.safeParse(config).success) {
-        return;
-    }
-    throw new Error('Navigation plugin schema invalid');
-}
-exports.assertConfig = assertConfig;
-const buildHookListener = (contentTypeName, context) => (hookName) => [
-    hookName,
-    async (event) => {
-        await getPluginService(context, 'common').runLifeCycleHook({
-            contentTypeName,
-            hookName,
-            event,
-        });
-    },
-];
-exports.buildHookListener = buildHookListener;
-const buildAllHookListeners = (contentTypeName, context) => Object.fromEntries(constants_1.allLifecycleHooks.map((0, exports.buildHookListener)(contentTypeName, context)));
-exports.buildAllHookListeners = buildAllHookListeners;
-const getPluginModels = ({ strapi, }) => {
-    const plugin = strapi.plugin('navigation');
-    return {
-        masterModel: plugin.contentType('navigation'),
-        itemModel: plugin.contentType('navigation-item'),
-        relatedModel: plugin.contentType('navigations-items-related'),
-        audienceModel: plugin.contentType('audience'),
-    };
-};
-exports.getPluginModels = getPluginModels;
-function getPluginService({ strapi }, name) {
-    return strapi.plugin('navigation').service(name);
-}
-exports.getPluginService = getPluginService;
-const parsePopulateQuery = (populate) => {
-    if (populate === '*') {
-        return true;
-    }
-    else if (typeof populate === 'string') {
-        return [populate];
-    }
-    else {
-        return populate;
-    }
-};
-exports.parsePopulateQuery = parsePopulateQuery;
-const isContentTypeEligible = (uid = '') => {
-    const isOneOfAllowedType = !!constants_1.ALLOWED_CONTENT_TYPES.find((_) => uid.includes(_));
-    const isNoneOfRestricted = !constants_1.RESTRICTED_CONTENT_TYPES.find((_) => uid.includes(_) || uid === _);
-    return !!uid && isOneOfAllowedType && isNoneOfRestricted;
-};
-exports.isContentTypeEligible = isContentTypeEligible;
-const singularize = (value = '') => {
-    return (0, lodash_1.last)(value) === 's' ? value.substr(0, value.length - 1) : value;
-};
-exports.singularize = singularize;

package/server/utils/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./constants"), exports);
-__exportStar(require("./functions"), exports);

package/strapi-admin.js

@@ -1,5 +0,0 @@
-'use strict';
-
-import admin from './admin';
-
-export default admin;

package/strapi-server.js

@@ -1,3 +0,0 @@
-'use strict';
-
-module.exports = require('./server');