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

package/i18n/LocaleContext.jsx

@@ -8,18 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import React, { createContext, useContext, useState } from 'react';
+import React, { createContext, useContext, useEffect, useState } from 'react';
 import { getPhrase, loadPhrases } from './i18n';
 const LocaleContext = createContext({
-    setLocale: (locale) => {
-    },
-    locale: '',
     dictionary: {},
+    locale: '',
     localize: (key, ...args) => key,
+    setLocale: (locale) => Promise.resolve({}),
 });
 export const useLocaleContext = () => useContext(LocaleContext);
-export const LocaleContextProvider = ({ children, locale }) => {
-    const [currentLocale, setLocaleState] = useState(locale);
+export const LocaleContextProvider = ({ children, locale: localeProps = '', }) => {
+    const [currentLocale, setLocaleState] = useState(localeProps);
     const [dictionary, setPhrasesState] = useState({});
     const setLocale = (locale) => __awaiter(void 0, void 0, void 0, function* () {
         setLocaleState(locale);
@@ -29,14 +28,19 @@ export const LocaleContextProvider = ({ children, locale }) => {
             return phrases;
         });
     });
-    if (locale && currentLocale !== locale) {
-        // async/await is not supported in client components yet
-        void setLocale(locale);
-    }
+    useEffect(() => {
+        if (localeProps) {
+            void setLocale(localeProps); // void to avoid @typescript-eslint/no-floating-promises
+        }
+    }, []);
     const localize = (key, ...args) => getPhrase(currentLocale, dictionary, key, ...args);
-    return (
-    // eslint-disable-next-line @typescript-eslint/no-misused-promises
-    <LocaleContext.Provider value={{ setLocale, locale: currentLocale, dictionary, localize }}>
+    return (<LocaleContext.Provider value={{
+            setLocale,
+            locale: currentLocale,
+            dictionary,
+            localize,
+        }}>
             {children}
         </LocaleContext.Provider>);
 };
+//# sourceMappingURL=LocaleContext.jsx.map

package/i18n/LocaleContext.jsx.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocaleContext.jsx","sourceRoot":"","sources":["../../src/i18n/LocaleContext.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;;;;;;AAGb,OAAO,KAAK,EAAE,EAAC,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAC,MAAM,OAAO,CAAC;AAC5E,OAAO,EAAC,SAAS,EAAE,WAAW,EAAC,MAAM,QAAQ,CAAC;AAG9C,MAAM,aAAa,GAAG,aAAa,CAAoB;IACnD,UAAU,EAAE,EAAE;IACd,MAAM,EAAE,EAAE;IACV,QAAQ,EAAE,CAAC,GAAW,EAAE,GAAG,IAAW,EAAE,EAAE,CAAC,GAAG;IAC9C,SAAS,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;CACrD,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AAEhE,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,EAClC,QAAQ,EACR,MAAM,EAAE,WAAW,GAAG,EAAE,GAI3B,EAAE,EAAE;IACD,MAAM,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC;IAC9D,MAAM,CAAC,UAAU,EAAE,eAAe,CAAC,GAAG,QAAQ,CAAO,EAAE,CAAC,CAAC;IAEzD,MAAM,SAAS,GAAG,CAAO,MAAc,EAAiB,EAAE;QACtD,cAAc,CAAC,MAAM,CAAC,CAAC;QACvB,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;YACxC,eAAe,CAAC,OAAO,CAAC,CAAC;YACzB,OAAO,CAAC,IAAI,CAAC,0CAA0C,MAAM,GAAG,CAAC,CAAC;YAClE,OAAO,OAAO,CAAC;QACnB,CAAC,CAAC,CAAC;IACP,CAAC,CAAA,CAAC;IAEF,SAAS,CAAC,GAAG,EAAE;QACX,IAAI,WAAW,EAAE,CAAC;YACd,KAAK,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,wDAAwD;QACzF,CAAC;IACL,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAE,GAAG,IAAW,EAAE,EAAE,CAAC,SAAS,CAAC,aAAa,EAAE,UAAU,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAErG,OAAO,CACH,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC3B,SAAS;YACT,MAAM,EAAE,aAAa;YACrB,UAAU;YACV,QAAQ;SACX,CAAC,CACE;YAAA,CAAC,QAAQ,CACb;QAAA,EAAE,aAAa,CAAC,QAAQ,CAAC,CAC5B,CAAC;AACN,CAAC,CAAC"}

package/i18n/i18n.d.ts

@@ -1,6 +1,4 @@
-export type Dict = {
-    [key: string]: string;
-};
+import type { Dict } from '../types';
 export declare class I18n {
     private static locale;
     private static dictionary;

package/i18n/i18n.js

@@ -44,7 +44,7 @@ export const getPhrase = (locale, dict, key, ...args) => {
         console.warn(`Missing localization phrase for locale "${locale}": <${key}>`);
         return `<${key}>`;
     }
-    if (args === null || args === void 0 ? void 0 : args.length) {
+    if (args.length) {
         let index = -1;
         return template.replace(/{(\d+)?}/g, (match, digit) => {
             var _a;
@@ -54,3 +54,4 @@ export const getPhrase = (locale, dict, key, ...args) => {
     }
     return template;
 };
+//# sourceMappingURL=i18n.js.map

package/i18n/i18n.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i18n.js","sourceRoot":"","sources":["../../src/i18n/i18n.ts"],"names":[],"mappings":";;;;;;;;;AAGA,MAAM,OAAO,IAAI;IAIN,MAAM,CAAO,SAAS,CAAC,MAAc;;YACxC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YACrB,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;gBACxC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC;gBAC1B,OAAO,CAAC,IAAI,CAAC,0CAA0C,MAAM,GAAG,CAAC,CAAC;gBAClE,OAAO,OAAO,CAAC;YACnB,CAAC,CAAC,CAAC;QACP,CAAC;KAAA;IAEM,MAAM,CAAC,QAAQ,CAAC,GAAW,EAAE,GAAG,IAAW;QAC9C,OAAO,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IACjE,CAAC;IAEM,MAAM,CAAC,SAAS;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,aAAa;QACvB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;;AAtBc,WAAM,GAAG,EAAE,CAAC;AACZ,eAAU,GAAS,EAAE,CAAC;AAwBzC,MAAM,CAAC,MAAM,WAAW,GAAG,CAAO,MAAc,EAAiB,EAAE;IAC/D,OAAO,MAAM,CAAC,YAAY,MAAM,OAAO,CAAC;SACnC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC;SAChC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;QACT,OAAO,CAAC,KAAK,CAAC,sCAAsC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC;QAClE,OAAO,EAAE,CAAC;IACd,CAAC,CAAC,CAAC;AACX,CAAC,CAAA,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,MAAc,EAAE,IAAU,EAAE,GAAW,EAAE,GAAG,IAAW,EAAE,EAAE;IACjF,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3B,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,OAAO,CAAC,IAAI,CAAC,2CAA2C,MAAM,OAAO,GAAG,GAAG,CAAC,CAAC;QAC7E,OAAO,IAAI,GAAG,GAAG,CAAC;IACtB,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC;QACf,OAAO,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;;YAClD,KAAK,EAAE,CAAC;YACR,OAAO,MAAA,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,mCAAI,KAAK,CAAC;QACzC,CAAC,CAAC,CAAC;IACP,CAAC;IACD,OAAO,QAAQ,CAAC;AACpB,CAAC,CAAC"}

package/index.d.ts

@@ -1,7 +1,14 @@
-export * from './utils';
-export * from './guillotine/fetchContent';
-export * from './guillotine/getMetaData';
-export * from './ComponentRegistry';
-export * from './UrlProcessor';
-export * from './i18n/i18n';
-export * from './i18n/LocaleContext';
+export { APP_NAME, APP_NAME_DASHED, APP_NAME_UNDERSCORED, IS_DEV_MODE, } from './common/env';
+export type * from './types';
+export { ComponentRegistry } from './common/ComponentRegistry';
+export { CATCH_ALL, JSESSIONID_HEADER, PORTAL_COMPONENT_ATTRIBUTE, PORTAL_REGION_ATTRIBUTE, PROJECT_ID_HEADER, RENDER_MODE, RENDER_MODE_HEADER, XP_BASE_URL_HEADER, XP_COMPONENT_TYPE, XP_REQUEST_TYPE, } from './common/constants';
+export { richTextQuery } from './guillotine/metadata/richTextQuery';
+export { validateData } from './guillotine/validateData';
+export { I18n } from './i18n/i18n';
+export { getContentApiUrl } from './utils/getContentApiUrl';
+export { getProjectLocaleConfig } from './utils/getProjectLocaleConfig';
+export { getProjectLocaleConfigById } from './utils/getProjectLocaleConfigById';
+export { getProjectLocaleConfigByLocale } from './utils/getProjectLocaleConfigByLocale';
+export { getRequestLocaleInfo } from './utils/getRequestLocaleInfo';
+export { sanitizeGraphqlName } from './utils/sanitizeGraphqlName';
+export { UrlProcessor, getAsset, getUrl, } from './common/UrlProcessor';

package/index.js

@@ -1,7 +1,14 @@
-export * from './utils';
-export * from './guillotine/fetchContent';
-export * from './guillotine/getMetaData';
-export * from './ComponentRegistry';
-export * from './UrlProcessor';
-export * from './i18n/i18n';
-export * from './i18n/LocaleContext';
+export { APP_NAME, APP_NAME_DASHED, APP_NAME_UNDERSCORED, IS_DEV_MODE, } from './common/env';
+export { ComponentRegistry } from './common/ComponentRegistry';
+export { CATCH_ALL, JSESSIONID_HEADER, PORTAL_COMPONENT_ATTRIBUTE, PORTAL_REGION_ATTRIBUTE, PROJECT_ID_HEADER, RENDER_MODE, RENDER_MODE_HEADER, XP_BASE_URL_HEADER, XP_COMPONENT_TYPE, XP_REQUEST_TYPE, } from './common/constants';
+export { richTextQuery } from './guillotine/metadata/richTextQuery';
+export { validateData } from './guillotine/validateData';
+export { I18n } from './i18n/i18n';
+export { getContentApiUrl } from './utils/getContentApiUrl';
+export { getProjectLocaleConfig } from './utils/getProjectLocaleConfig';
+export { getProjectLocaleConfigById } from './utils/getProjectLocaleConfigById';
+export { getProjectLocaleConfigByLocale } from './utils/getProjectLocaleConfigByLocale';
+export { getRequestLocaleInfo } from './utils/getRequestLocaleInfo';
+export { sanitizeGraphqlName } from './utils/sanitizeGraphqlName';
+export { UrlProcessor, getAsset, getUrl, } from './common/UrlProcessor';
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,QAAQ,EACR,eAAe,EACf,oBAAoB,EACpB,WAAW,GACd,MAAM,cAAc,CAAC;AAItB,OAAO,EAAC,iBAAiB,EAAC,MAAM,4BAA4B,CAAC;AAE7D,OAAO,EACH,SAAS,EACT,iBAAiB,EACjB,0BAA0B,EAC1B,uBAAuB,EACvB,iBAAiB,EACjB,WAAW,EACX,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,eAAe,GAClB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EAAC,aAAa,EAAC,MAAM,qCAAqC,CAAC;AAClE,OAAO,EAAC,YAAY,EAAC,MAAM,2BAA2B,CAAC;AAEvD,OAAO,EAAC,IAAI,EAAC,MAAM,aAAa,CAAC;AAEjC,OAAO,EAAC,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAC,sBAAsB,EAAC,MAAM,gCAAgC,CAAC;AACtE,OAAO,EAAC,0BAA0B,EAAC,MAAM,oCAAoC,CAAC;AAC9E,OAAO,EAAC,8BAA8B,EAAC,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAC,oBAAoB,EAAC,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAC,mBAAmB,EAAC,MAAM,6BAA6B,CAAC;AAEhE,OAAO,EACH,YAAY,EACZ,QAAQ,EACR,MAAM,GACT,MAAM,uBAAuB,CAAC"}

package/package.json

@@ -1,37 +1,85 @@
 {
   "name": "@enonic/nextjs-adapter",
-  "version": "3.0.0-B1",
+  "version": "3.0.0-B3",
   "license": "Apache-2.0",
   "main": "index.js",
+  "author": "Pavel Milkevich <pmi@enonic.com>",
+  "contributors": [
+    "Christian Westgaard <cwe@enonic.com>"
+  ],
+  "files": [
+    "*.d.ts",
+    "*.map",
+    "baseMappings*",
+    "client.js",
+    "common",
+    "guillotine",
+    "index*",
+    "i18n",
+    "query",
+    "src",
+    "types",
+    "utils",
+    "views"
+  ],
+  "keywords": [
+    "enonic",
+    "nextjs",
+    "adapter",
+    "typescript",
+    "ecmascript"
+  ],
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "copy": "npx --yes cpy-cli package.json README.md dist",
-    "build": "tsc --build tsconfig.json",
+    "clean": "del-cli *.d.ts *.js.map baseMappings.* client.* server.* common coverage index.* enonic-nextjs-adapter-*.tgz guillotine i18n query types utils views dist",
+    "build": "tsc",
+    "build:prod": "tsc --outDir ./dist && npx --yes cpy-cli package.json README.md ./dist",
+    "release": "concurrently -c auto -g --timings npm:test npm:lint npm:build:prod",
+    "check:types": "tsc --noEmit",
+    "madge": "madge -i docs/madge.png -x '(constants|env)\\.ts' src/index.ts",
     "lint": "eslint --quiet src",
-    "lint:fix": "eslint --fix src"
+    "lint:fix": "eslint --fix src",
+    "prebuild:prod": "npm run clean",
+    "prebuild": "npm run clean",
+    "premadge": "mkdirp docs",
+    "pretest": "del-cli coverage",
+    "test": "jest --no-cache --coverage"
   },
   "dependencies": {
-    "@formatjs/intl-localematcher": "^0.5.2",
-    "html-react-parser": "^5.0.11",
-    "lru-cache": "^10.0.1",
+    "@formatjs/intl-localematcher": "^0.5.4",
+    "html-react-parser": "^5.1.2",
     "negotiator": "^0.6.3",
-    "next": "^14.0.4",
+    "next": "^14.1.0",
     "react": "18.2.0",
     "react-dom": "18.2.0",
     "unescape": "^1.0.1"
   },
   "devDependencies": {
+    "@edge-runtime/jest-environment": "^2.3.9",
+    "@enonic-types/core": "^7.14.0-B2",
     "@enonic/eslint-config": "^1.1.0",
+    "@testing-library/jest-dom": "^6.4.2",
+    "@testing-library/react": "^14.2.1",
     "@types/negotiator": "^0.6.3",
-    "@types/node": "^20.10.7",
-    "@types/react": "18.2.47",
-    "@types/react-dom": "18.2.18",
-    "@typescript-eslint/eslint-plugin": "^6.18.1",
-    "@typescript-eslint/parser": "^6.18.1",
+    "@types/node": "^20.11.17",
+    "@types/react": "^18.2.55",
+    "@types/react-dom": "^18.2.19",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "concurrently": "^8.2.2",
+    "cpy-cli": "^5.0.0",
+    "del-cli": "^5.1.0",
     "eslint": "^8.56.0",
     "eslint-plugin-react": "^7.33.2",
-    "typescript": "^5.2.2"
-  }
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "madge": "^6.1.0",
+    "mkdirp": "^3.0.1",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.3"
+  },
+  "types": "index.d.ts"
 }

package/query/Shortcut.js

@@ -12,3 +12,4 @@ export const getShortcutQuery = `
       }
     }
   }`;
+//# sourceMappingURL=Shortcut.js.map

package/query/Shortcut.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Shortcut.js","sourceRoot":"","sources":["../../src/query/Shortcut.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,gBAAgB,GAAG;;;;;;;;;;;;;IAa5B,CAAC"}

package/server.d.ts

@@ -0,0 +1,5 @@
+export { fetchContent } from './guillotine/fetchContent';
+export { fetchContentPathsForAllLocales } from './guillotine/fetchContentPathsForAllLocales';
+export { fetchContentPathsForLocale } from './guillotine/fetchContentPathsForLocale';
+export { fetchFromApi } from './guillotine/fetchFromApi';
+export { fetchGuillotine } from './guillotine/fetchGuillotine';

package/server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAC,8BAA8B,EAAC,MAAM,6CAA6C,CAAC;AAC3F,OAAO,EAAC,0BAA0B,EAAC,MAAM,yCAAyC,CAAC;AACnF,OAAO,EAAC,YAAY,EAAC,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAC,eAAe,EAAC,MAAM,8BAA8B,CAAC"}

package/types/component.d.ts

@@ -0,0 +1,114 @@
+/// <reference types="react" />
+import type { XP_COMPONENT_TYPE } from '../common/constants';
+import type { Context } from './next';
+export interface ComponentDefinitionParams {
+    query?: SelectedQueryMaybeVariablesFunc;
+    configQuery?: string;
+    processor?: DataProcessor;
+    view?: React.FunctionComponent<any>;
+}
+/**
+ *  Object that configures the handling of a particular content type. All attributes are optional (see examples below), and missing values will fall back to default behavior:
+ *          - 'query' (used in fetchContent.ts) Guillotine query for fetching content data, may also have a function that supplies guillotine variables. So, 'query' can EITHER be only a query string, OR also add a get-guillotine-variables function. In the latter case, 'query' can be an object with 'query' and 'variables' attributes, or an array where the query string is first and the get-variables function is second. Either way, the get-variables function takes two arguments: path (content path, mandatory) and context (next.js-supplied Context from getServerSideProps etc. Optional, and requires that fetchContent is called with the context, of course).
+ *          - 'props' (used in fetchContent.ts) is a function for processing props after fetching them
+ *          - 'view' (used in BasePage.tsx) is a React component: top-level content-type-specific rendering with the props first fetched from guillotine (and then optionally preprocessed with the function in 'props').
+ */
+export interface ComponentDefinition {
+    catchAll?: boolean;
+    query?: SelectedQueryMaybeVariablesFunc;
+    configQuery?: string;
+    processor?: DataProcessor;
+    view?: React.FunctionComponent<any>;
+}
+export interface ComponentDescriptor {
+    type?: ComponentDefinition;
+    component?: PageComponent;
+    queryAndVariables?: QueryAndVariables;
+}
+export type ComponentDictionary = Record<string, ComponentDefinitionParams>;
+export type DataProcessor = (data: any, context?: Context, config?: any) => Promise<Record<string, any>>;
+export interface FragmentData {
+    id: string;
+    fragment: {
+        components: PageComponent[];
+    };
+}
+export interface ImageData {
+    ref: string;
+    image: {
+        id: string;
+    } | null;
+}
+export interface LayoutData {
+    descriptor: string;
+    config?: any;
+    [customKeysFromQuery: string]: any;
+}
+export interface LinkData {
+    ref: string;
+    media: {
+        content: {
+            id: string;
+        };
+    } | null;
+}
+export type MacroConfig = Record<string, any>;
+export interface MacroData {
+    ref: string;
+    name: string;
+    descriptor: string;
+    config: Record<string, MacroConfig>;
+}
+export interface PageComponent {
+    [key: string]: any;
+    type: XP_COMPONENT_TYPE;
+    path: string;
+    page?: PageData;
+    part?: PartData;
+    layout?: LayoutData;
+    fragment?: FragmentData;
+    text?: TextData;
+    image?: any;
+    regions?: RegionTree;
+    data?: any;
+    error?: any;
+}
+export interface PageData {
+    descriptor: string;
+    config?: any;
+    template?: string | null;
+    regions?: RegionTree;
+}
+export interface PageRegion {
+    name: string;
+    components: PageComponent[];
+}
+export interface PartData {
+    descriptor: string;
+    config: any;
+    [customKeysFromQuery: string]: any;
+}
+export interface QueryAndVariables {
+    query: string;
+    variables?: Record<string, any>;
+}
+export type QueryGetter = (path: string, context?: Context, config?: any) => string;
+export type SelectedQueryMaybeVariablesFunc = string | QueryGetter | {
+    query: string | QueryGetter;
+    variables: VariablesGetter;
+} | [string | QueryGetter, VariablesGetter];
+export type RegionTree = Record<string, PageRegion>;
+export interface RichTextData {
+    processedHtml: string;
+    links: LinkData[];
+    macros: MacroData[];
+    images: ImageData[];
+}
+export interface TextData {
+    value: RichTextData;
+}
+export type VariablesGetter = (path: string, context?: Context, config?: any) => VariablesGetterResult;
+export interface VariablesGetterResult {
+    [variables: string]: any;
+    path: string;
+}

package/types/component.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=component.js.map

package/types/component.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"component.js","sourceRoot":"","sources":["../../src/types/component.ts"],"names":[],"mappings":""}

package/types/componentProps.d.ts

@@ -0,0 +1,104 @@
+/// <reference types="react" />
+import { DOMNode } from 'html-react-parser';
+import type { RENDER_MODE, XP_REQUEST_TYPE } from '../common/constants';
+import type { FragmentData, LayoutData, MacroConfig, MacroData, PageComponent, PageData, PartData, RichTextData, RegionTree } from './component';
+export interface BaseComponentProps {
+    component: PageComponent;
+    meta: MetaData;
+    common?: any;
+}
+export interface BaseLayoutProps {
+    component?: LayoutData;
+    path: string;
+    regions?: RegionTree;
+    common?: any;
+    meta: MetaData;
+}
+export interface BaseMacroProps {
+    data: MacroData;
+    meta: MetaData;
+    renderInEditMode?: boolean;
+}
+export interface BasePageProps {
+    component?: PageData;
+    path?: string;
+    common?: any;
+    data?: any;
+    error?: string;
+    meta: MetaData;
+}
+export interface BasePartProps {
+    component?: PartData;
+    path: string;
+    common?: any;
+    data?: any;
+    error?: string;
+    meta: MetaData;
+}
+export interface FragmentProps {
+    page?: PageData;
+    component?: FragmentData;
+    common?: any;
+    meta: MetaData;
+}
+export interface LayoutProps {
+    layout: LayoutData;
+    path: string;
+    common: any;
+    meta: MetaData;
+}
+export interface MacroProps {
+    name: string;
+    config: MacroConfig;
+    meta: MetaData;
+}
+export interface MetaData {
+    type: string;
+    path: string;
+    requestType: XP_REQUEST_TYPE;
+    renderMode: RENDER_MODE;
+    requestedComponent?: PageComponent;
+    canRender: boolean;
+    catchAll: boolean;
+    apiUrl: string;
+    baseUrl: string;
+    locale: string;
+    defaultLocale: string;
+}
+export interface PageProps {
+    page: PageData;
+    path: string;
+    data?: any;
+    common?: any;
+    meta: MetaData;
+}
+export interface PartProps {
+    part: PartData;
+    path: string;
+    data?: any;
+    common?: any;
+    meta: MetaData;
+}
+export interface RegionProps {
+    name: string;
+    components?: PageComponent[];
+    className?: string;
+    common?: any;
+    meta: MetaData;
+}
+export interface RegionsProps {
+    page: PageData | null;
+    name?: string;
+    common?: any;
+    meta: MetaData;
+}
+export type Replacer = (domNode: DOMNode, data: RichTextData, meta: MetaData, renderMacroInEditMode: boolean) => ReplacerResult;
+export type ReplacerResult = JSX.Element | object | void | undefined | null | false;
+export interface RichTextViewProps {
+    data: RichTextData;
+    meta: MetaData;
+    className?: string;
+    tag?: string;
+    renderMacroInEditMode?: boolean;
+    customReplacer?: Replacer;
+}

package/types/componentProps.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=componentProps.js.map

package/types/componentProps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"componentProps.js","sourceRoot":"","sources":["../../src/types/componentProps.ts"],"names":[],"mappings":""}