@enonic/nextjs-adapter 3.0.0-B1 → 3.0.0-B3

package/utils.js

@@ -1,255 +0,0 @@
-import Negotiator from 'negotiator';
-import { match as localeMatcher } from '@formatjs/intl-localematcher';
-const mode = process.env.MODE || process.env.NEXT_PUBLIC_MODE;
-export const IS_DEV_MODE = (mode === 'development');
-export var ENV_VARS;
-(function (ENV_VARS) {
-    ENV_VARS["PROJECTS"] = "ENONIC_PROJECTS";
-    ENV_VARS["API"] = "ENONIC_API";
-    ENV_VARS["API_TOKEN"] = "ENONIC_API_TOKEN";
-})(ENV_VARS || (ENV_VARS = {}));
-/** URL to the guillotine API */
-const API_URL = (process.env.ENONIC_API || process.env.NEXT_PUBLIC_ENONIC_API);
-/** Locales and Enonic XP projects correspondence list */
-const PROJECTS = (process.env.ENONIC_PROJECTS || process.env.NEXT_PUBLIC_ENONIC_PROJECTS);
-/** Optional utility value - defining in one place the name of the target app (the app that defines the content types, the app name is therefore part of the content type strings used both in typeselector and in query introspections) */
-export const APP_NAME = (process.env.ENONIC_APP_NAME || process.env.NEXT_PUBLIC_ENONIC_APP_NAME);
-/** Optional utility value - derived from APP_NAME, only with underscores instead of dots */
-export const APP_NAME_UNDERSCORED = (APP_NAME || '').replace(/\./g, '_');
-/** Optional utility value - derived from APP_NAME, only with dashes instead of dots */
-export const APP_NAME_DASHED = (APP_NAME || '').replace(/\./g, '-');
-const PROJECT_CONFIG_REGEXP = new RegExp('^([\\w-]+):([^\\/\\s]+)(\\/[\\w-.]+)?$', 'i');
-// ////////////////////////////////////////////////////////////////////////  Hardcode-able constants
-// URI parameter marking that a request is for a preview for CS. MUST MATCH THE VALUE OF 'FROM_XP_PARAM' on XP side.
-export const XP_BASE_URL_HEADER = 'xpbaseurl';
-export const RENDER_MODE_HEADER = 'content-studio-mode';
-export const PROJECT_ID_HEADER = 'content-studio-project';
-export const JSESSIONID_HEADER = 'jsessionid';
-export const PORTAL_COMPONENT_ATTRIBUTE = 'data-portal-component-type';
-export const PORTAL_REGION_ATTRIBUTE = 'data-portal-region';
-export const FRAGMENT_CONTENTTYPE_NAME = 'portal:fragment';
-export const FRAGMENT_DEFAULT_REGION_NAME = 'fragment';
-export const PAGE_TEMPLATE_CONTENTTYPE_NAME = 'portal:page-template';
-export const PAGE_TEMPLATE_FOLDER = 'portal:template-folder';
-export const SITE_CONTENTTYPE_NAME = 'portal:site';
-export const LOCALE_HEADER = 'locale';
-export const LOCALES_HEADER = 'locales';
-export const DEFAULT_LOCALE_HEADER = 'default-locale';
-/** excluded contents:
- * - folder
- * - shortcuts (redirect can't be used in prerender)
- * - media
- * - paths with '/_' in them
- */
-export const GET_STATIC_PATHS_QUERY = `query ($count: Int) {
-  guillotine {
-    queryDsl(
-      first: $count,
-      sort: {
-        field: "modifiedTime",
-        direction: DESC     
-      }
-      query: {boolean: {mustNot: [
-        {in: {field: "type", stringValues: ["base:folder", "base:shortcut"]}}
-        {like: {field: "type", value: "media:*"}}
-        {like: {field: "_path", value: "*/_*"}}
-      ]}}
-    ) {
-      _name
-      _path
-      site {_name}
-    }
-  }
-}`;
-// ------------------------------- Exports and auxillary functions derived from values above ------------------------------------
-export var XP_REQUEST_TYPE;
-(function (XP_REQUEST_TYPE) {
-    XP_REQUEST_TYPE["COMPONENT"] = "component";
-    XP_REQUEST_TYPE["TYPE"] = "type";
-    XP_REQUEST_TYPE["PAGE"] = "page";
-})(XP_REQUEST_TYPE || (XP_REQUEST_TYPE = {}));
-export var RENDER_MODE;
-(function (RENDER_MODE) {
-    RENDER_MODE["INLINE"] = "inline";
-    RENDER_MODE["EDIT"] = "edit";
-    RENDER_MODE["PREVIEW"] = "preview";
-    RENDER_MODE["LIVE"] = "live";
-    RENDER_MODE["ADMIN"] = "admin";
-    RENDER_MODE["NEXT"] = "next"; // Fallback: not using XP proxy but rendering directly with next.js
-})(RENDER_MODE || (RENDER_MODE = {}));
-// TODO: Use these instead of hardcoded strings everywhere
-export var XP_COMPONENT_TYPE;
-(function (XP_COMPONENT_TYPE) {
-    XP_COMPONENT_TYPE["PART"] = "part";
-    XP_COMPONENT_TYPE["LAYOUT"] = "layout";
-    XP_COMPONENT_TYPE["TEXT"] = "text";
-    XP_COMPONENT_TYPE["FRAGMENT"] = "fragment";
-    XP_COMPONENT_TYPE["PAGE"] = "page";
-})(XP_COMPONENT_TYPE || (XP_COMPONENT_TYPE = {}));
-export const getRenderMode = (context) => {
-    var _a;
-    const value = (_a = context.headers) === null || _a === void 0 ? void 0 : _a.get(RENDER_MODE_HEADER);
-    const enumValue = RENDER_MODE[value === null || value === void 0 ? void 0 : value.toUpperCase()];
-    return enumValue || RENDER_MODE[process.env.RENDER_MODE] || RENDER_MODE.NEXT;
-};
-export function getRequestLocaleInfo(context) {
-    var _a, _b, _c;
-    let locale;
-    const configs = getProjectLocaleConfigs();
-    const locales = Object.keys(configs);
-    const defaultLocale = locales.find((locale) => configs[locale].default);
-    const projectId = (_a = context.headers) === null || _a === void 0 ? void 0 : _a.get(PROJECT_ID_HEADER);
-    if (projectId) {
-        locale = (_b = getProjectLocaleConfigById(projectId, false)) === null || _b === void 0 ? void 0 : _b.locale;
-    }
-    else {
-        locale = context.locale;
-        if (!locale) {
-            const acceptLang = ((_c = context.headers) === null || _c === void 0 ? void 0 : _c.get('accept-language')) || '';
-            const langs = new Negotiator({ headers: { 'accept-language': acceptLang } }).languages();
-            locale = localeMatcher(langs, locales, defaultLocale);
-        }
-    }
-    return { locale, locales, defaultLocale };
-}
-export function getProjectLocaleConfig(context) {
-    var _a;
-    const projectId = (_a = context.headers) === null || _a === void 0 ? void 0 : _a.get(PROJECT_ID_HEADER);
-    let config;
-    if (projectId) {
-        // first use project id header
-        config = getProjectLocaleConfigById(projectId, false);
-    }
-    if (!config) {
-        // next try to use locale from url
-        // it will fall back to default locale if not found
-        config = getProjectLocaleConfigByLocale(context.locale);
-    }
-    return config;
-}
-export function getProjectLocales() {
-    return Object.keys(getProjectLocaleConfigs());
-}
-export function getProjectLocaleConfigById(projectId, useDefault = true) {
-    const configs = getProjectLocaleConfigs();
-    let config;
-    if (projectId) {
-        config = Object.values(configs).find(p => {
-            var _a;
-            return ((_a = p === null || p === void 0 ? void 0 : p.project) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === projectId.toLowerCase();
-        });
-    }
-    if (!config && useDefault) {
-        config = Object.values(configs).find(c => c.default);
-    }
-    return config;
-}
-export function getProjectLocaleConfigByLocale(locale, useDefault = true) {
-    const configs = getProjectLocaleConfigs();
-    let config;
-    if (locale) {
-        config = configs[locale];
-    }
-    if (!config && useDefault) {
-        config = Object.values(configs).find(c => c.default);
-    }
-    return config;
-}
-export function getProjectLocaleConfigs() {
-    const str = PROJECTS;
-    const envVarName = ENV_VARS.PROJECTS;
-    if (!(str === null || str === void 0 ? void 0 : str.length)) {
-        throw new Error(`Did you forget to define "${ENV_VARS.PROJECTS}" environmental variable?
-        Format: <default-language>:<default-repository-name>/<default-site-path>,<language>:<repository-name>/<site-path>,...`);
-    }
-    return str.split(',').reduce((config, prjStr, index) => {
-        const matches = PROJECT_CONFIG_REGEXP.exec(prjStr === null || prjStr === void 0 ? void 0 : prjStr.trim());
-        if (!(matches === null || matches === void 0 ? void 0 : matches.length)) {
-            return config;
-        }
-        const [full, lang, project, site] = matches;
-        if (project && site) {
-            config[lang] = {
-                default: index === 0,
-                project,
-                site,
-                locale: lang,
-            };
-        }
-        else {
-            throw Error(`Wrong configuration in "${envVarName}": ${prjStr}.
-            Format: <default-language>:<default-repository-name>/<default-site-path>,<language>:<repository-name>/<site-path>,...`);
-        }
-        return config;
-    }, {});
-}
-export function fixDoubleSlashes(str) {
-    return str.replace(/(^|[^:/])\/{2,}/g, '$1/');
-}
-export function getContentApiUrl(context) {
-    const project = getProjectLocaleConfig(context).project;
-    const branch = getRenderMode(context) === RENDER_MODE.NEXT ? 'master' : 'draft';
-    return fixDoubleSlashes(`${API_URL}/${project}/${branch}`);
-}
-export function addJsessionHeaders(target = {}, context) {
-    var _a;
-    const jsessionid = (_a = context.headers) === null || _a === void 0 ? void 0 : _a.get(JSESSIONID_HEADER);
-    if (jsessionid) {
-        target['Cookie'] = `${JSESSIONID_HEADER}=${jsessionid}`;
-    }
-}
-export function addLocaleHeaders(target = {}, locale, locales, defaultLocale) {
-    target[LOCALE_HEADER] = locale;
-    target[LOCALES_HEADER] = JSON.stringify(locales);
-    target[DEFAULT_LOCALE_HEADER] = defaultLocale;
-}
-export const getXpBaseUrl = (context) => {
-    var _a;
-    const header = ((_a = context.headers) === null || _a === void 0 ? void 0 : _a.get(XP_BASE_URL_HEADER)) || '/';
-    // TODO: workaround for XP pattern controller mapping not picked up in edit mode
-    return header.replace(/\/edit\//, '/inline/');
-};
-export const commonChars = (s1, s2) => {
-    let result = '';
-    if (!s1 || s1.length === 0 || !s2 || s2.length === 0) {
-        return result;
-    }
-    for (let i = 0; i < s1.length; i++) {
-        const s1Element = s1[i];
-        if (s2[i] === s1Element) {
-            result += s1Element;
-        }
-        else {
-            break;
-        }
-    }
-    return result;
-};
-// sanitizes text according to graphql naming spec http://spec.graphql.org/October2021/#sec-Names
-export const sanitizeGraphqlName = (text) => {
-    if (!text || text.trim().length === 0) {
-        return '';
-    }
-    let result = text.replace(/([^0-9A-Za-z])+/g, '_');
-    if (result.length > 0 && /[0-9]/.test(result.charAt(0))) {
-        result = '_' + result;
-    }
-    return result;
-};
-// ---------------------------------------------------------------------------------------------------------------- Export
-const adapterConstants = {
-    IS_DEV_MODE,
-    APP_NAME,
-    APP_NAME_UNDERSCORED,
-    APP_NAME_DASHED,
-    PORTAL_COMPONENT_ATTRIBUTE,
-    PORTAL_REGION_ATTRIBUTE,
-};
-// Verify required values
-const NOT_REQUIRED = ['IS_DEV_MODE'];
-Object.keys(adapterConstants).forEach(key => {
-    if (NOT_REQUIRED.indexOf(key) === -1 && !adapterConstants[key]) {
-        throw Error(`constants.ts: Config value '${key}' is missing (from .env?)`);
-    }
-});
-export default adapterConstants;