@enonic/nextjs-adapter 3.3.0-B1 → 3.3.0

package/src/types/guillotine.ts

@@ -1,428 +0,0 @@
-import type {PublishInfo} from '@enonic-types/core';
-import type {PageComponent, PageData} from './component';
-import type {MetaData} from './componentProps';
-import type {Context} from './next';
-import type {RecursivePartial} from './util';
-
-
-export interface GuillotineError {
-    errorType: string
-    locations: {
-        line: number
-        column: number
-    }[]
-    message: string
-    validationErrorType?: string
-}
-
-// A specific observed error
-// export interface GuillotineValidationError extends GuillotineError {
-//     errorType: 'ValidationError'
-//     validationErrorType: string // 'FieldUndefined'
-// }
-
-// export interface GuillotineErrorResponseJson {
-//     errors: GuillotineError[]
-// }
-
-// export interface GuillotineOkResponseJson<Data = Record<string,unknown>> {
-//     data: Data
-// }
-
-// export type GuillotineResponseJson<Data> = GuillotineOkResponseJson<Data> | GuillotineErrorResponseJson;
-
-export interface GuillotineResponseJson<Guillotine = RecursivePartial<HeadlessCms>> {
-    // NOTE: guillotine is the actual field on the top Query, but can be used multiple times via aliases
-    data?: Record<string, Guillotine>
-    errors?: GuillotineError[]
-}
-
-export interface GuillotineResponse<Data = Record<string,unknown>> {
-    json: () => Promise<GuillotineResponseJson<Data>>
-    text: () => Promise<string>
-    ok: boolean
-    status: number
-}
-
-/**
- * Sends one query to the guillotine API and asks for content type, then uses the type to select a second query and variables, which is sent to the API and fetches content data.
- * @param contentPath string or string array: pre-split or slash-delimited _path to a content available on the API
- * @returns FetchContentResult object: {data?: T, error?: {code, message}}
- */
-export type ContentFetcher = (context: Context) => Promise<FetchContentResult>;
-
-export interface ContentResult<Content = Record<string, unknown>> extends Result {
-    contents?: Content[]
-}
-
-export interface FetchContentResult extends Result {
-    data: Record<string, any> | null
-    common: Record<string, any> | null
-    meta: MetaData
-    page: PageComponent | null
-}
-
-// Seems like NodeJS.fetch lowercases all headers, so we need to lowercase the
-// header names here.
-export interface GuillotineRequestHeaders {
-    [key: string]: string | undefined;
-    Cookie?: string
-    locale: string
-    locales: string
-    'default-locale': string
-}
-
-export type GuillotineResult = Result & Record<string, any>;
-
-export interface MetaResult extends Result {
-    meta?: {
-        _id: string
-        _path: string
-        type: string
-        pageAsJson?: PageData
-        components?: PageComponent[]
-    }
-}
-
-export interface Result {
-    error?: {
-        code: string
-        message: string
-    } | null
-}
-
-// Types from Query Playground Docs:
-
-interface AccessControlEntry {
-    principal: PrincipalKey
-    allow: [Permission]
-    deny: [Permission]
-}
-
-interface Attachment {
-    name: string
-    label: string
-    size: number
-    mimeType: string
-    attachmentUrl: string
-}
-
-type DateTime = string;
-
-export interface Component {
-    type: ComponentType
-    path: string
-    page?: PageComponentData | null
-    layout?: LayoutComponentData | null
-    image?: ImageComponentData | null
-    part?: PartComponentData | null
-    text?: TextComponentData | null
-    fragment?: FragmentComponentData | null
-}
-
-type ComponentType = 'page' | 'layout' | 'image' | 'part' | 'text' | 'fragment';
-
-interface Content {
-    _id: string // !
-    _name: string // !
-    _path: string // !
-    _references?: Content[]
-    _score?: number
-    creator?: PrincipalKey
-    modifier?: PrincipalKey
-    createdTime?: DateTime
-    modifiedTime?: DateTime
-    owner?: PrincipalKey
-    type?: string
-    contentType?: ContentType
-    displayName?: string
-    hasChildren?: boolean
-    language?: string
-    valid?: boolean
-    dataAsJson?: JSON
-    x?: ExtraData
-    xAsJson?: JSON
-    pageAsJson?: JSON
-    pageTemplate?: Content
-    components?: Component[]
-    attachments?: Attachment[]
-    publish?: PublishInfo
-    pageUrl?: string
-    site?: portal_Site
-    parent?: Content
-    children?: Content[]
-    childrenConnection?: ContentConnection
-    permissions?: Permissions
-}
-
-interface ContentConnection {
-    totalCount: Int
-    edges: ContentEdge[]
-    pageInfo: PageInfo
-}
-
-interface ContentEdge {
-    node: Content
-    cursor: string
-}
-
-interface ContentType {
-    name: string
-    displayName: string
-    description: string
-    superType: string
-    abstract: boolean
-    final: boolean
-    allowChildContent: boolean
-    contentDisplayNameScript: string
-    icon: Icon
-    form: FormItem[]
-    formAsJson: JSON
-    getInstances: Content[]
-    getInstanceConnection: ContentConnection
-}
-
-type ExtraData<App = Record<string,unknown>> = App & {
-    media: XData_media_ApplicationConfig
-    base: XData_base_ApplicationConfig
-};
-
-type Float = number;
-
-interface FormItem {
-    formItemType: FormItemType
-    name: string
-    label: string
-}
-
-type FormItemType = 'ItemSet' | 'Layout' | 'Input' | 'OptionSet';
-
-interface FragmentComponentData {
-    id: string
-    fragment: Content
-}
-
-interface GeoPoint {
-    value: string
-    latitude: Float
-    longitude: Float
-}
-
-export interface HeadlessCms {
-    get?: Content
-    getChildren?: Content[]
-    getChildrenConnection?: ContentConnection
-    getPermissions?: Permissions
-    getSite?: portal_Site
-    getType?: ContentType
-    getTypes?: ContentType[]
-    query?: Content[]
-    queryConnection?: QueryContentConnection
-    queryDsl?: Content[]
-    queryDslConnection?: QueryDSLContentConnection
-}
-
-interface Icon {
-    mimeType: string
-    modifiedTime: string
-}
-
-interface Image {
-    image: Content
-    ref: string
-    style: ImageStyle
-}
-
-interface ImageComponentData {
-    id: string
-    caption?: string
-    image: media_Image
-}
-
-interface ImageStyle {
-    name: string
-    aspectRatio: string
-    filter: string
-}
-
-type Int = number;
-
-type JSON = Record<string, unknown>;
-
-interface LayoutComponentData {
-    descriptor: string
-    configAsJson: JSON | null
-}
-
-interface Link {
-    ref: string
-    uri: string
-    media: Media
-    content: Content
-}
-
-type LocalDateTime = string;
-
-interface Macro_system_disable_DataConfig {
-    body: string
-}
-
-interface Macro_system_embed_DataConfig {
-    body: string
-}
-
-interface Macro {
-    ref: string
-    name: string
-    descriptor: string
-    config: MacroConfig
-}
-
-interface MacroConfig {
-    disable: Macro_system_disable_DataConfig
-    embed: Macro_system_embed_DataConfig
-}
-
-interface Media {
-    content: Content
-    intent: MediaIntentType
-}
-
-type MediaIntentType = 'download' | 'inline';
-
-interface media_Image extends Content {
-    mediaUrl: string
-    imageUrl: string
-    data: media_Image_Data
-}
-
-interface media_Image_Data {
-    media: MediaUploader
-    caption: string
-    altText: string
-    artist: string[]
-    copyright: string
-    tags: string[]
-}
-
-interface MediaFocalPoint {
-    x: number
-    y: number
-}
-
-interface MediaUploader {
-    attachment: string
-    focalPoint: MediaFocalPoint
-}
-
-interface PageComponentData {
-    descriptor?: string
-    customized?: boolean
-    configAsJson?: JSON
-    template?: Content | null
-}
-
-interface PageInfo {
-    startCursor: string // !
-    endCursor: string // !
-    hasNext: boolean // !
-}
-
-interface PartComponentData<Config = Record<string, unknown>> {
-    descriptor: string
-    config: Config
-    configAsJson: JSON
-}
-
-type Permission = 'READ' | 'CREATE' | 'MODIFY' | 'DELETE' | 'PUBLISH' | 'READ_PERMISSIONS' | 'WRITE_PERMISSIONS';
-
-interface Permissions {
-    inheritsPermissions: boolean
-    permissions: AccessControlEntry[]
-}
-
-interface portal_Site extends Content {
-    data: portal_Site_Data
-}
-
-interface portal_Site_Data {
-    description: string
-}
-
-type PrincipalType = 'user' | 'group' | 'role';
-
-interface PrincipalKey {
-    value: string
-    type: PrincipalType
-    idProvider: string
-    principalId: string
-}
-
-interface QueryContentConnection extends ContentConnection {
-    aggregationsAsJson: JSON
-}
-
-interface QueryDSLContentConnection extends QueryContentConnection {
-    highlightAsJson: JSON
-}
-
-interface RichText {
-    raw: string
-    processedHtml: string
-    macrosAsJson: JSON
-    macros: Macro[]
-    images: Image[]
-    links: Link[]
-}
-
-interface TextComponentData {
-    value: RichText
-}
-
-interface XData_base_ApplicationConfig {
-    gpsInfo: XData_base_gpsInfo_DataConfig
-}
-
-interface XData_base_gpsInfo_DataConfig {
-    geoPoint: GeoPoint
-    altitude: string
-    direction: string
-}
-
-interface XData_media_ApplicationConfig {
-    imageInfo: XData_media_imageInfo_DataConfig
-    cameraInfo: XData_media_cameraInfo_DataConfig
-}
-
-interface XData_media_imageInfo_DataConfig {
-    pixelSize: number
-    imageHeight: number
-    imageWidth: number
-    contentType: string
-    description: string
-    byteSize: number
-    colorSpace: string[]
-    fileSource: string
-}
-
-interface XData_media_cameraInfo_DataConfig {
-    date: LocalDateTime
-    make: string
-    model: string
-    lens: string
-    iso: string
-    focalLength: string
-    focalLength35: string
-    exposureBias: string
-    aperture: string[]
-    shutterTime: string
-    flash: string
-    autoFlashCompensation: string
-    whiteBalance: string
-    exposureProgram: string
-    shootingMode: string
-    meteringMode: string
-    exposureMode: string
-    focusDistance: string
-    orientation: string
-}

package/src/types/i18n.ts

@@ -1,8 +0,0 @@
-export type Dict = Record<string, string>;
-
-export interface LocaleContextType {
-    dictionary: Dict
-    locale: string
-    localize: (key: string, ...args: any[]) => string
-    setLocale: (locale: string) => Promise<Dict>
-}

package/src/types/next.ts

@@ -1,7 +0,0 @@
-import type {ReadonlyHeaders} from 'next/dist/server/web/spec-extension/adapters/headers';
-
-export interface Context {
-    headers?: ReadonlyHeaders | Headers
-    locale?: string
-    contentPath: string | string[]
-}

package/src/types/util.ts

@@ -1,5 +0,0 @@
-export type RecursivePartial<T> = {
-    [P in keyof T]?: RecursivePartial<T[P]>;
-};
-
-// export type PartialExcept<T, K extends keyof T> = RecursivePartial<T> & Pick<T, K>;

package/src/utils/addLineNumbers.ts

@@ -1,3 +0,0 @@
-export function addLineNumbers(s: string) {
-    return s.split('\n').map((line, i) => `${i + 1}: ${line}`).join('\n');
-}

package/src/utils/buildGuillotineRequestHeaders.ts

@@ -1,29 +0,0 @@
-import type {Context, GuillotineRequestHeaders} from '../types';
-
-
-import {GUILLOTINE_REQUEST_HEADERS, JSESSIONID_HEADER} from '../common/constants';
-
-
-export function buildGuillotineRequestHeaders({
-    context,
-    defaultLocale,
-    locale,
-    locales
-}: {
-    context: Context
-    defaultLocale: string
-    locale: string
-    locales: string[]
-}): GuillotineRequestHeaders {
-    const guillotineRequestHeaders: GuillotineRequestHeaders = {
-        [GUILLOTINE_REQUEST_HEADERS.DEFAULT_LOCALE]: defaultLocale,
-        [GUILLOTINE_REQUEST_HEADERS.LOCALE]: locale,
-        [GUILLOTINE_REQUEST_HEADERS.LOCALES]: JSON.stringify(locales)
-    };
-    const jsessionid = context.headers?.get(JSESSIONID_HEADER);
-    if (jsessionid) {
-        guillotineRequestHeaders[GUILLOTINE_REQUEST_HEADERS.COOKIE] =
-            `${JSESSIONID_HEADER}=${jsessionid}`;
-    }
-    return guillotineRequestHeaders;
-}

package/src/utils/enonicLog.ts

@@ -1,28 +0,0 @@
-import {LOGGING} from '../common/env';
-
-export const enonicDebug = (s?: string, ...params: any[]) => {
-    enonicPrint('debug', s, ...params);
-};
-
-export const enonicLog = (s?: string, ...params: any[]) => {
-    enonicPrint('log', s, ...params);
-};
-
-export const enonicInfo = (s?: string, ...params: any[]) => {
-    enonicPrint('info', s, ...params);
-};
-
-export const enonicWarn = (s?: string, ...params: any[]) => {
-    enonicPrint('warn', s, ...params);
-};
-
-export const enonicError = (s?: string, ...params: any[]) => {
-    enonicPrint('error', s, ...params);
-};
-
-const enonicPrint = (type: 'log' | 'debug' | 'info' | 'warn' | 'error', s?: string, ...params: any[]) => {
-    if (LOGGING) {
-        const m = `\n[${new Date().toLocaleTimeString()}] ${s}:\n`;
-        console[type](m, ...params, '\n');
-    }
-};

package/src/utils/fixDoubleSlashes.ts

@@ -1,3 +0,0 @@
-export function fixDoubleSlashes(str: string) {
-    return str.replace(/(^|[^:/])\/{2,}/g, '$1/');
-}

package/src/utils/getAllLocales.ts

@@ -1,6 +0,0 @@
-import {getLocaleMappings} from './getLocaleMappings';
-
-
-export function getAllLocales(): string[] {
-    return Object.keys(getLocaleMappings());
-}

package/src/utils/getContentApiUrl.ts

@@ -1,20 +0,0 @@
-import type {Context} from '../types';
-
-
-import {RENDER_MODE} from '../common/constants';
-import {API_URL} from '../common/env';
-import {getLocaleMapping} from './getLocaleMapping';
-import {fixDoubleSlashes} from './fixDoubleSlashes';
-import {getRenderMode} from './getRenderMode';
-
-
-export function getContentApiUrl(context: Context): string {
-    const project = getLocaleMapping(context).project;
-    const branch = getRenderMode(context) === RENDER_MODE.NEXT
-        ? 'master'
-        : getRenderMode(context) === RENDER_MODE.LIVE
-            ? 'master'
-            : 'draft';
-
-    return fixDoubleSlashes(`${API_URL}/${project}/${branch}`);
-}

package/src/utils/getLocaleMapping.ts

@@ -1,24 +0,0 @@
-import type {Context, LocaleMapping} from '../types';
-
-
-import {PROJECT_ID_HEADER} from '../common/constants';
-import {getLocaleMappingByProjectId} from './getLocaleMappingByProjectId';
-import {getLocaleMappingByLocale} from './getLocaleMappingByLocale';
-
-
-export function getLocaleMapping(context: Context): LocaleMapping {
-    const projectId = context.headers?.get(PROJECT_ID_HEADER);
-
-    let config: LocaleMapping;
-    if (projectId) {
-        // first use project id header
-        config = getLocaleMappingByProjectId(projectId, false);
-    }
-    if (!config) {
-        // next try to use locale from url
-        // it will fall back to default locale if not found
-        config = getLocaleMappingByLocale(context.locale);
-    }
-
-    return config;
-}

package/src/utils/getLocaleMappingByLocale.ts

@@ -1,19 +0,0 @@
-import type {LocaleMapping} from '../types';
-
-
-import {getLocaleMappings} from './getLocaleMappings';
-
-
-export function getLocaleMappingByLocale(locale?: string, useDefault = true): LocaleMapping {
-    const mappings = getLocaleMappings();
-
-    let config: LocaleMapping;
-    if (locale) {
-        config = mappings[locale];
-    }
-    if (!config && useDefault) {
-        config = Object.values(mappings).find(c => c.default);
-    }
-
-    return config;
-}

package/src/utils/getLocaleMappingByProjectId.ts

@@ -1,21 +0,0 @@
-import type {LocaleMapping} from '../types';
-
-
-import {getLocaleMappings} from './getLocaleMappings';
-
-
-export function getLocaleMappingByProjectId(projectId?: string, useDefault = true): LocaleMapping {
-    const mappings = getLocaleMappings();
-
-    let config: LocaleMapping;
-    if (projectId) {
-        config = Object.values(mappings).find(p => {
-            return p?.project?.toLowerCase() === projectId.toLowerCase();
-        });
-    }
-    if (!config && useDefault) {
-        config = Object.values(mappings).find(c => c.default);
-    }
-
-    return config;
-}

package/src/utils/getRenderMode.ts

@@ -1,11 +0,0 @@
-import type {Context} from '../types';
-
-
-import {RENDER_MODE, RENDER_MODE_HEADER} from '../common/constants';
-
-
-export const getRenderMode = (context: Context): RENDER_MODE => {
-    const value = context.headers?.get(RENDER_MODE_HEADER);
-    const enumValue = RENDER_MODE[(value as keyof typeof RENDER_MODE)?.toUpperCase()];
-    return enumValue || RENDER_MODE[process.env.RENDER_MODE] || RENDER_MODE.NEXT;
-};

package/src/utils/getXpBaseUrl.ts

@@ -1,12 +0,0 @@
-import type {Context} from '../types';
-
-
-import {XP_BASE_URL_HEADER} from '../common/constants';
-
-
-export const getXpBaseUrl = (context: Context): string => {
-    const header = context.headers?.get(XP_BASE_URL_HEADER) || '/';
-
-    // TODO: workaround for XP pattern controller mapping not picked up in edit mode
-    return header.replace(/\/edit\//, '/inline/');
-};

package/src/utils/indent.ts

@@ -1,4 +0,0 @@
-export const indent = (s: string, count = 2, indentChar = ' ') => s
-    .split('\n')
-    .map((line) => `${indentChar.repeat(count)}${line}`)
-    .join('\n');

package/src/views/BaseContent.tsx

@@ -1,47 +0,0 @@
-/// <reference types="react" />
-import type {BasePageProps, FetchContentResult} from '../types';
-
-
-import {ComponentRegistry} from '../common/ComponentRegistry';
-import BasePage from './BasePage';
-
-
-const BaseContent = (props: FetchContentResult) => {
-    const {common, meta, page} = props;
-
-    if (!meta?.type) {
-        console.warn("BaseContent props are missing 'meta.type'");
-        return null;
-    }
-
-    const pageData = page?.page;
-    const pageDesc = pageData?.descriptor;
-    const typeDef = ComponentRegistry.getContentType(meta.type);
-    const ContentTypeView = typeDef?.view;
-
-    if (ContentTypeView && !typeDef?.catchAll) {
-        return <ContentTypeView {...props}/>;
-    } else if (pageDesc) {
-        const pageAttrs: BasePageProps = {
-            component: pageData,
-            path: page?.path,
-            meta,
-            common
-        };
-        if (page?.data) {
-            pageAttrs.data = page.data;
-        }
-        if (page?.error) {
-            pageAttrs.error = page.error;
-        }
-
-        return <BasePage {...pageAttrs}/>;
-    } else if (ContentTypeView) {
-        return <ContentTypeView {...props}/>;
-    }
-
-    console.log(`BaseContent: can not render ${meta.type}: no content type or page view defined`);
-    return null;
-};
-
-export default BaseContent;