@enonic/nextjs-adapter 2.0.1 → 2.0.2

package/server/index.js

@@ -0,0 +1,132 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withEnonicCache = exports.PURGE_CACHE_URL = void 0;
+var http_1 = require("http");
+var cache_1 = require("./cache");
+var path_1 = __importDefault(require("path"));
+var hostname = process.env.HOST || '127.0.0.1';
+var dev = process.env.NODE_ENV !== 'production';
+var port = process.env.PORT && parseInt(process.env.PORT, 10) || (dev ? 3000 : 4242);
+exports.PURGE_CACHE_URL = '/_/enonic/cache/purge';
+var withEnonicCache = function (config) {
+    var exp = config.experimental || {};
+    exp.isrMemoryCacheSize = exp.isrMemoryCacheSize || 1000000;
+    exp.incrementalCacheHandlerPath = path_1.default.resolve(__dirname, 'ClearableFileCache.js');
+    config.experimental = exp;
+    return config;
+};
+exports.withEnonicCache = withEnonicCache;
+// Not typed to prevent collision of local types with end-user ones
+exports.default = (function (next) { return __awaiter(void 0, void 0, void 0, function () {
+    var nextServer, nextHandler;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                nextServer = next({ dev: dev, hostname: hostname, port: port });
+                nextHandler = nextServer.getRequestHandler();
+                return [4 /*yield*/, nextServer.prepare().then(function () { return __awaiter(void 0, void 0, void 0, function () {
+                        var nextNodeServer, opts, purgeUrl, server;
+                        var _a;
+                        return __generator(this, function (_b) {
+                            switch (_b.label) {
+                                case 0: return [4 /*yield*/, ((_a = nextServer['getServer']) === null || _a === void 0 ? void 0 : _a.call(nextServer))];
+                                case 1:
+                                    nextNodeServer = _b.sent();
+                                    if (!nextNodeServer) {
+                                        console.error('Unable to access incremental cache, cache purge endpoint will be disabled');
+                                        return [2 /*return*/, nextServer];
+                                    }
+                                    opts = nextNodeServer['serverOptions'].conf;
+                                    purgeUrl = ((opts === null || opts === void 0 ? void 0 : opts.basePath) || '') + exports.PURGE_CACHE_URL;
+                                    console.info("Staring cache purge endpoint at ".concat(purgeUrl, "..."));
+                                    server = (0, http_1.createServer)(function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
+                                        var parsedUrl, tokenParam, cache, pathParam;
+                                        return __generator(this, function (_a) {
+                                            switch (_a.label) {
+                                                case 0:
+                                                    parsedUrl = new URL("http://".concat(hostname, ":").concat(port).concat(req.url || ''));
+                                                    if (!(parsedUrl.pathname !== purgeUrl)) return [3 /*break*/, 2];
+                                                    return [4 /*yield*/, nextHandler(req, res)];
+                                                case 1:
+                                                    _a.sent();
+                                                    return [3 /*break*/, 5];
+                                                case 2:
+                                                    if (!dev) return [3 /*break*/, 3];
+                                                    console.warn('\nCache clearing is not available in DEV mode.\n');
+                                                    res.setHeader('Content-Type', 'application/json');
+                                                    res.end(JSON.stringify({ purged: false }));
+                                                    return [3 /*break*/, 5];
+                                                case 3:
+                                                    tokenParam = parsedUrl.searchParams.get('token');
+                                                    if (tokenParam !== process.env.ENONIC_API_TOKEN) {
+                                                        // XP hijacks 401 to show login page, so send 407 instead
+                                                        res.statusCode = 407;
+                                                        res.end(JSON.stringify({ message: 'Invalid token' }));
+                                                        return [2 /*return*/];
+                                                    }
+                                                    cache = nextNodeServer.getIncrementalCache({
+                                                        requestHeaders: Object.assign({}, req.headers),
+                                                    });
+                                                    pathParam = parsedUrl.searchParams.get('path') || undefined;
+                                                    return [4 /*yield*/, (0, cache_1.purgeCache)(cache, pathParam)];
+                                                case 4:
+                                                    _a.sent();
+                                                    res.setHeader('Content-Type', 'application/json');
+                                                    res.end(JSON.stringify({ purged: true }));
+                                                    _a.label = 5;
+                                                case 5: return [2 /*return*/];
+                                            }
+                                        });
+                                    }); }).listen(port, hostname, function () {
+                                        console.info("Server ready on ".concat(hostname, ":").concat(port));
+                                    }).on('error', function (e) {
+                                        console.error('Server error:', e);
+                                        server.close();
+                                    });
+                                    return [2 /*return*/, nextServer];
+                            }
+                        });
+                    }); })];
+            case 1: return [2 /*return*/, _a.sent()];
+        }
+    });
+}); });

package/utils.d.ts

@@ -0,0 +1,114 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/** Import config values from .env, .env.development and .env.production */
+import { GetServerSidePropsContext } from 'next';
+import { ParsedUrlQuery } from 'node:querystring';
+import { IncomingHttpHeaders } from 'http';
+export declare const IS_DEV_MODE: boolean;
+export declare const PURGE_CACHE_URL = "/_/enonic/cache/purge";
+export declare enum ENV_VARS {
+    PROJECTS = "ENONIC_PROJECTS",
+    API = "ENONIC_API",
+    API_TOKEN = "ENONIC_API_TOKEN"
+}
+/** 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 declare const APP_NAME: string;
+/** Optional utility value - derived from APP_NAME, only with underscores instead of dots */
+export declare const APP_NAME_UNDERSCORED: string;
+/** Optional utility value - derived from APP_NAME, only with dashes instead of dots */
+export declare const APP_NAME_DASHED: string;
+export declare const XP_BASE_URL_HEADER = "xpbaseurl";
+export declare const RENDER_MODE_HEADER = "content-studio-mode";
+export declare const PROJECT_ID_HEADER = "content-studio-project";
+export declare const JSESSIONID_HEADER = "jsessionid";
+export declare const PORTAL_COMPONENT_ATTRIBUTE = "data-portal-component-type";
+export declare const PORTAL_REGION_ATTRIBUTE = "data-portal-region";
+export declare const FRAGMENT_CONTENTTYPE_NAME = "portal:fragment";
+export declare const FRAGMENT_DEFAULT_REGION_NAME = "fragment";
+export declare const PAGE_TEMPLATE_CONTENTTYPE_NAME = "portal:page-template";
+export declare const PAGE_TEMPLATE_FOLDER = "portal:template-folder";
+export declare const SITE_CONTENTTYPE_NAME = "portal:site";
+export declare const LOCALE_HEADER = "locale";
+export declare const LOCALES_HEADER = "locales";
+export declare const DEFAULT_LOCALE_HEADER = "default-locale";
+/** excluded contents:
+ * - folder
+ * - shortcuts (redirect can't be used in prerender)
+ * - media
+ * - paths with '/_' in them
+ */
+export declare const GET_STATIC_PATHS_QUERY = "query ($count: Int) {\n  guillotine {\n    queryDsl(\n      first: $count,\n      sort: {\n        field: \"modifiedTime\",\n        direction: DESC     \n      }\n      query: {boolean: {mustNot: [\n        {in: {field: \"type\", stringValues: [\"base:folder\", \"base:shortcut\"]}}\n        {like: {field: \"type\", value: \"media:*\"}}\n        {like: {field: \"_path\", value: \"*/_*\"}}\n      ]}}\n    ) {\n      _name\n      _path\n      site {_name}\n    }\n  }\n}";
+export declare enum XP_REQUEST_TYPE {
+    COMPONENT = "component",
+    TYPE = "type",
+    PAGE = "page"
+}
+export declare enum RENDER_MODE {
+    INLINE = "inline",
+    EDIT = "edit",
+    PREVIEW = "preview",
+    LIVE = "live",
+    ADMIN = "admin",
+    NEXT = "next"
+}
+export declare enum XP_COMPONENT_TYPE {
+    PART = "part",
+    LAYOUT = "layout",
+    TEXT = "text",
+    FRAGMENT = "fragment",
+    PAGE = "page"
+}
+export interface ServerSideParams extends ParsedUrlQuery {
+    contentPath?: string[];
+    mode?: string;
+}
+export interface PreviewParams {
+    contentPath: string[];
+    headers: Record<string, string>;
+    params: Record<string, string>;
+}
+export type Context = GetServerSidePropsContext<ServerSideParams, PreviewParams>;
+export type LocaleProjectConfig = {
+    project: string;
+    site: string;
+    locale: string;
+};
+export type LocaleProjectConfigs = {
+    default: LocaleProjectConfig;
+    [locale: string]: LocaleProjectConfig;
+};
+export interface MinimalContext {
+    req?: {
+        headers: IncomingHttpHeaders;
+    };
+    locale?: string;
+    defaultLocale?: string;
+    locales?: string[];
+}
+export interface ContentPathItem {
+    params: {
+        contentPath: string[];
+    };
+    locale?: string;
+}
+export declare const getRenderMode: (context?: MinimalContext) => RENDER_MODE;
+export declare function normalizeLocale(locale: string): string | undefined;
+export declare function getLocaleProjectConfig(context?: MinimalContext): LocaleProjectConfig;
+export declare function getLocaleProjectConfigById(projectId?: string, useDefault?: boolean): LocaleProjectConfig;
+export declare function getLocaleProjectConfigs(): LocaleProjectConfigs;
+export declare function fixDoubleSlashes(str: string): string;
+export declare function getContentApiUrl(context?: MinimalContext): string;
+export declare function addJsessionHeaders(headers?: Object, context?: MinimalContext): void;
+export declare function addLocaleHeaders(headers?: Object, context?: Context): void;
+export declare const getXpBaseUrl: (context?: MinimalContext) => string;
+export declare const commonChars: (s1?: string, s2?: string, wordSeparators?: string) => string;
+export declare const sanitizeGraphqlName: (text: string) => string;
+declare const adapterConstants: {
+    IS_DEV_MODE: boolean;
+    APP_NAME: string;
+    APP_NAME_UNDERSCORED: string;
+    APP_NAME_DASHED: string;
+    PORTAL_COMPONENT_ATTRIBUTE: string;
+    PORTAL_REGION_ATTRIBUTE: string;
+};
+export default adapterConstants;

package/{src/utils.ts → utils.js}

@@ -1,60 +1,39 @@
-/** Import config values from .env, .env.development and .env.production */
-import {GetServerSidePropsContext} from 'next';
-import {ParsedUrlQuery} from 'node:querystring';
-import {IncomingHttpHeaders} from 'http';
-
 const mode = process.env.MODE || process.env.NEXT_PUBLIC_MODE;
 export const IS_DEV_MODE = (mode === 'development');
-
 export const PURGE_CACHE_URL = '/_/enonic/cache/purge';
-
-export enum ENV_VARS {
-    PROJECTS = 'ENONIC_PROJECTS',
-    API = 'ENONIC_API',
-    API_TOKEN = 'ENONIC_API_TOKEN',
-}
-
+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)
@@ -81,93 +60,49 @@ export const GET_STATIC_PATHS_QUERY = `query ($count: Int) {
     }
   }
 }`;
-
-
 // ------------------------------- Exports and auxillary functions derived from values above ------------------------------------
-
-export enum XP_REQUEST_TYPE {
-    COMPONENT = 'component',
-    TYPE = 'type',
-    PAGE = 'page',
-}
-
-export enum RENDER_MODE {
-    INLINE = 'inline',
-    EDIT = 'edit',
-    PREVIEW = 'preview',
-    LIVE = 'live',
-    ADMIN = 'admin',
-    NEXT = 'next'       // Fallback: not using XP proxy but rendering directly with next.js
-}
-
+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 enum XP_COMPONENT_TYPE {
-    PART = 'part',
-    LAYOUT = 'layout',
-    TEXT = 'text',
-    FRAGMENT = 'fragment',
-    PAGE = 'page',
-}
-
-export interface ServerSideParams
-    extends ParsedUrlQuery {
-    // String array catching a sub-path assumed to match the site-relative path of an XP content.
-    contentPath?: string[];
-    mode?: string;
-}
-
-export interface PreviewParams {
-    contentPath: string[];
-    headers: Record<string, string>;
-    params: Record<string, string>;
-}
-
-export type Context = GetServerSidePropsContext<ServerSideParams, PreviewParams>;
-
-export type LocaleProjectConfig = {
-    project: string;
-    site: string;
-    locale: string;
-};
-
-export type LocaleProjectConfigs = {
-    default: LocaleProjectConfig;
-    [locale: string]: LocaleProjectConfig;
-};
-
-export interface MinimalContext {
-    req?: {
-        headers: IncomingHttpHeaders;
-    }
-    locale?: string;
-    defaultLocale?: string;
-    locales?: string[];
-}
-
-export interface ContentPathItem {
-    params: { contentPath: string[] },
-    locale?: string,
-}
-
-export const getRenderMode = (context?: MinimalContext): RENDER_MODE => {
-    const value = (context?.req?.headers || {})[RENDER_MODE_HEADER] as string | undefined;
-    const enumValue = RENDER_MODE[<keyof typeof RENDER_MODE>value?.toUpperCase()];
+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 === null || context === void 0 ? void 0 : context.req) === null || _a === void 0 ? void 0 : _a.headers) || {})[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 normalizeLocale(locale: string): string | undefined {
+export function normalizeLocale(locale) {
     return locale !== 'default' ? locale : undefined;
 }
-
-export function getLocaleProjectConfig(context?: MinimalContext): LocaleProjectConfig {
-    const projectId = (context?.req?.headers || {})[PROJECT_ID_HEADER] as string | undefined;
+export function getLocaleProjectConfig(context) {
+    var _a;
+    const projectId = (((_a = context === null || context === void 0 ? void 0 : context.req) === null || _a === void 0 ? void 0 : _a.headers) || {})[PROJECT_ID_HEADER];
     if (projectId) {
         return getLocaleProjectConfigById(projectId);
     }
-
     const projectsConfig = getLocaleProjectConfigs();
-    const locale = context?.locale || context?.defaultLocale;
-    let config: LocaleProjectConfig = projectsConfig[locale];
+    const locale = (context === null || context === void 0 ? void 0 : context.locale) || (context === null || context === void 0 ? void 0 : context.defaultLocale);
+    let config = projectsConfig[locale];
     if (!config) {
         config = projectsConfig.default;
     }
@@ -175,32 +110,28 @@ export function getLocaleProjectConfig(context?: MinimalContext): LocaleProjectC
         throw new Error(`No config for locale "${locale}" found in "${ENV_VARS.PROJECTS}" environmental variable.
         Format: <default-repository-name>/<site-path>,<language>:<repository-name>/<site-path>,...`);
     }
-
     return config;
 }
-
-export function getLocaleProjectConfigById(projectId?: string, useDefault = true): LocaleProjectConfig {
-    const projects: LocaleProjectConfigs = getLocaleProjectConfigs();
+export function getLocaleProjectConfigById(projectId, useDefault = true) {
+    const projects = getLocaleProjectConfigs();
     if (!projectId) {
         return useDefault ? projects.default : undefined;
     }
-
     const match = Object.values(projects).find(p => {
-        return p?.project?.toLowerCase() === projectId.toLowerCase();
+        var _a;
+        return ((_a = p === null || p === void 0 ? void 0 : p.project) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === projectId.toLowerCase();
     });
-
     return match || (useDefault ? projects.default : undefined);
 }
-
-export function getLocaleProjectConfigs(): LocaleProjectConfigs {
+export function getLocaleProjectConfigs() {
     const str = PROJECTS;
     const envVarName = ENV_VARS.PROJECTS;
-    if (!str?.length) {
+    if (!(str === null || str === void 0 ? void 0 : str.length)) {
         throw Error(`"${envVarName}" environmental variable is required.`);
     }
-    const result: LocaleProjectConfigs = str.split(',').reduce((config, prjStr) => {
-        const matches: RegExpExecArray = PROJECT_CONFIG_REGEXP.exec(prjStr?.trim());
-        if (!matches?.length) {
+    const result = str.split(',').reduce((config, prjStr) => {
+        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 = 'default', project, site] = matches;
@@ -210,7 +141,8 @@ export function getLocaleProjectConfigs(): LocaleProjectConfigs {
                 site,
                 locale: lang,
             };
-        } else {
+        }
+        else {
             throw Error(`Wrong configuration in "${envVarName}": ${prjStr}.
             Format: <default-repository-name>/<site-path>,<language>:<repository-name>/<site-path>,...`);
         }
@@ -228,49 +160,42 @@ export function getLocaleProjectConfigs(): LocaleProjectConfigs {
     }
     return result;
 }
-
-export function fixDoubleSlashes(str: string) {
+export function fixDoubleSlashes(str) {
     return str.replace(/(^|[^:/])\/{2,}/g, '$1/');
 }
-
-export function getContentApiUrl(context?: MinimalContext): string {
+export function getContentApiUrl(context) {
     const project = getLocaleProjectConfig(context).project;
     const branch = getRenderMode(context) === RENDER_MODE.NEXT ? 'master' : 'draft';
-
     return fixDoubleSlashes(`${API_URL}/${project}/${branch}`);
 }
-
-export function addJsessionHeaders(headers: Object = {}, context?: MinimalContext): void {
-    const jsessionid = context?.req?.headers[JSESSIONID_HEADER];
+export function addJsessionHeaders(headers = {}, context) {
+    var _a;
+    const jsessionid = (_a = context === null || context === void 0 ? void 0 : context.req) === null || _a === void 0 ? void 0 : _a.headers[JSESSIONID_HEADER];
     if (jsessionid) {
         headers['Cookie'] = `${JSESSIONID_HEADER}=${jsessionid}`;
     }
 }
-
-export function addLocaleHeaders(headers: Object = {}, context?: Context): void {
-    const locale = context?.locale;
+export function addLocaleHeaders(headers = {}, context) {
+    const locale = context === null || context === void 0 ? void 0 : context.locale;
     if (locale) {
         headers[LOCALE_HEADER] = locale;
     }
-    const locales = context?.locales;
+    const locales = context === null || context === void 0 ? void 0 : context.locales;
     if (locales) {
         headers[LOCALES_HEADER] = JSON.stringify(locales);
     }
-    const defaultLocale = context?.defaultLocale;
+    const defaultLocale = context === null || context === void 0 ? void 0 : context.defaultLocale;
     if (defaultLocale) {
         headers[DEFAULT_LOCALE_HEADER] = defaultLocale;
     }
 }
-
-export const getXpBaseUrl = (context?: MinimalContext): string => {
-    const header = ((context?.req?.headers || {})[XP_BASE_URL_HEADER] || '') as string;
-
+export const getXpBaseUrl = (context) => {
+    var _a;
+    const header = ((((_a = context === null || context === void 0 ? void 0 : context.req) === null || _a === void 0 ? void 0 : _a.headers) || {})[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?: string, s2?: string, wordSeparators?: string) => {
+export const commonChars = (s1, s2, wordSeparators) => {
     let result = '';
     if (!s1 || s1.length === 0 || !s2 || s2.length === 0) {
         return result;
@@ -279,26 +204,26 @@ export const commonChars = (s1?: string, s2?: string, wordSeparators?: string) =
     let lastCommonIndex = -1;
     for (let i = 0; i < s1.length; i++) {
         const s1El = s1[i];
-        if (wordSeparators?.indexOf(s1El) >= 0) {
+        if ((wordSeparators === null || wordSeparators === void 0 ? void 0 : wordSeparators.indexOf(s1El)) >= 0) {
             lastSeparatorIndex = i;
         }
         if (s2[i] === s1El) {
             lastCommonIndex = i;
-        } else {
+        }
+        else {
             break;
         }
     }
-
     if (lastSeparatorIndex > 0 || lastCommonIndex === lastSeparatorIndex) {
         result = s1.substring(0, lastSeparatorIndex);
-    } else if (lastCommonIndex > -1) {
+    }
+    else if (lastCommonIndex > -1) {
         result = s1.substring(0, lastCommonIndex + 1);
     }
-
     return result;
 };
 // sanitizes text according to graphql naming spec http://spec.graphql.org/October2021/#sec-Names
-export const sanitizeGraphqlName = (text: string) => {
+export const sanitizeGraphqlName = (text) => {
     if (!text || text.trim().length === 0) {
         return '';
     }
@@ -308,9 +233,7 @@ export const sanitizeGraphqlName = (text: string) => {
     }
     return result;
 };
-
 // ---------------------------------------------------------------------------------------------------------------- Export
-
 const adapterConstants = {
     IS_DEV_MODE,
     APP_NAME,
@@ -319,7 +242,6 @@ const adapterConstants = {
     PORTAL_COMPONENT_ATTRIBUTE,
     PORTAL_REGION_ATTRIBUTE,
 };
-
 // Verify required values
 const NOT_REQUIRED = ['IS_DEV_MODE'];
 Object.keys(adapterConstants).forEach(key => {
@@ -327,5 +249,4 @@ Object.keys(adapterConstants).forEach(key => {
         throw Error(`constants.ts: Config value '${key}' is missing (from .env?)`);
     }
 });
-
 export default adapterConstants;

package/views/BaseComponent.d.ts

@@ -0,0 +1,25 @@
+import React from 'react';
+import { MetaData, PageComponent } from '../guillotine/getMetaData';
+export type BaseComponentProps = {
+    component: PageComponent;
+    meta: MetaData;
+    common?: any;
+};
+declare const BaseComponent: ({ component, meta, common }: BaseComponentProps) => JSX.Element;
+export default BaseComponent;
+export declare const MissingComponent: ({ descriptor, type }: {
+    descriptor?: string;
+    type: string;
+}) => React.JSX.Element;
+export declare function shouldShowMissingView(meta: MetaData): boolean;
+export declare const ErrorComponent: ({ type, descriptor, reason }: {
+    type?: string;
+    descriptor?: string;
+    reason: string;
+}) => React.JSX.Element;
+export declare function shouldShowErrorView(meta: MetaData): boolean;
+export declare const PlaceholderComponent: ({ type, descriptor }: {
+    type?: string;
+    descriptor?: string;
+}) => React.JSX.Element;
+export declare function shouldShowPlaceholderView(meta: MetaData): boolean;