@prezly/theme-kit-nextjs 3.3.1 → 4.0.0-alpha.0

package/src/data-fetching/api/PrezlyApi.ts

@@ -1,312 +0,0 @@
-import { createPrezlyClient, SortOrder } from '@prezly/sdk';
-import type {
-    Category,
-    Newsroom,
-    NewsroomLanguageSettings,
-    PrezlyClient,
-    Stories,
-    Story,
-} from '@prezly/sdk';
-import type { IncomingMessage } from 'http';
-
-import {
-    getCompanyInformation,
-    getDefaultLanguage,
-    getLanguageFromNextLocaleIsoCode,
-    getLanguageFromStory,
-    getNotifications,
-    LocaleObject,
-} from '../../intl';
-import type { PageProps, ServerSidePageProps } from '../../types';
-import { DEFAULT_PAGE_SIZE } from '../../utils';
-import { getAlgoliaSettings, isSdkError, isUuid } from '../lib';
-
-import { toPaginationParams } from './lib';
-import {
-    getChronologicalSortOrder,
-    getContactsQuery,
-    getGalleriesQuery,
-    getSlugQuery,
-    getStoriesQuery,
-} from './queries';
-
-const CATEGORIES_SORT_ORDER = '+order';
-const DEFAULT_SORT_ORDER = SortOrder.Direction.DESC;
-
-const ERROR_CODE_NOT_FOUND = 404;
-const ERROR_CODE_FORBIDDEN = 403;
-const ERROR_CODE_GONE = 410;
-
-interface GetStoriesOptions {
-    page?: number;
-    pageSize?: number;
-    order?: `${SortOrder.Direction}`;
-    pinning?: boolean;
-    include?: (keyof Story.ExtraFields)[];
-    localeCode?: string;
-    /**
-     * When set to `true`, the result for the first page will include one extra story to place as highlighted story.
-     * This will offset each subsequent page by 1 story to account for that.
-     */
-    withHighlightedStory?: boolean;
-}
-
-interface GetGalleriesOptions {
-    page?: number;
-    pageSize?: number;
-}
-
-export class PrezlyApi {
-    private readonly sdk: PrezlyClient;
-
-    private readonly newsroomUuid: Newsroom['uuid'];
-
-    private readonly themeUuid: string | undefined;
-
-    constructor(accessToken: string, newsroomUuid: Newsroom['uuid'], themeUuid?: string) {
-        const baseUrl = process.env.API_BASE_URL_OVERRIDE ?? undefined;
-        this.sdk = createPrezlyClient({
-            accessToken,
-            baseUrl,
-            // This returns stories created by legacy version of the editor in a format that can be displayed by the Prezly Content Renderer.
-            headers: { 'X-Convert-v1-To-v3': 'true' },
-        });
-        this.newsroomUuid = newsroomUuid;
-        this.themeUuid = themeUuid;
-    }
-
-    async getStory(uuid: string) {
-        if (!isUuid(uuid)) {
-            return undefined;
-        }
-
-        try {
-            const story = await this.sdk.stories.get(uuid);
-            return story;
-        } catch (error) {
-            if (
-                isSdkError(error) &&
-                (error.status === ERROR_CODE_NOT_FOUND ||
-                    error.status === ERROR_CODE_GONE ||
-                    error.status === ERROR_CODE_FORBIDDEN)
-            ) {
-                return null;
-            }
-            throw error;
-        }
-    }
-
-    async getNewsroom() {
-        return this.sdk.newsrooms.get(this.newsroomUuid);
-    }
-
-    async getNewsroomContacts() {
-        return this.sdk.newsroomContacts.search(this.newsroomUuid, {
-            query: JSON.stringify(getContactsQuery()),
-        });
-    }
-
-    async getNewsroomLanguages(): Promise<NewsroomLanguageSettings[]> {
-        return (await this.sdk.newsroomLanguages.list(this.newsroomUuid)).languages;
-    }
-
-    /**
-     * Note: this method returns ALL stories from the newsroom. It's intended to be used for sitemaps and not to display actual content.
-     */
-    async getAllStories({ order = DEFAULT_SORT_ORDER, pinning = false }: GetStoriesOptions = {}) {
-        const sortOrder = getChronologicalSortOrder(order, pinning);
-        const newsroom = await this.getNewsroom();
-        const query = JSON.stringify(getStoriesQuery(newsroom.uuid));
-        const maxStories = newsroom.stories_number;
-        const chunkSize = 200;
-
-        const pages = Math.ceil(maxStories / chunkSize);
-        const storiesPromises = Array.from({ length: pages }, (_, pageIndex) =>
-            this.searchStories({
-                limit: chunkSize,
-                sortOrder,
-                query,
-                offset: pageIndex * chunkSize,
-            }),
-        );
-
-        const stories = (await Promise.all(storiesPromises)).flatMap(
-            (response) => response.stories,
-        );
-
-        return stories;
-    }
-
-    async getStories({
-        page = undefined,
-        pageSize = DEFAULT_PAGE_SIZE,
-        order = DEFAULT_SORT_ORDER,
-        pinning = false,
-        include,
-        localeCode,
-        withHighlightedStory,
-    }: GetStoriesOptions = {}) {
-        const sortOrder = getChronologicalSortOrder(order, pinning);
-        const query = JSON.stringify(getStoriesQuery(this.newsroomUuid, undefined, localeCode));
-
-        const { offset, limit } = toPaginationParams({ page, pageSize, withHighlightedStory });
-
-        const { stories, pagination } = await this.searchStories({
-            limit,
-            offset,
-            sortOrder,
-            query,
-            include,
-        });
-
-        const storiesTotal = pagination.matched_records_number;
-
-        return { stories, storiesTotal };
-    }
-
-    async getStoriesFromCategory(
-        category: Category,
-        {
-            page = undefined,
-            pageSize = DEFAULT_PAGE_SIZE,
-            order = DEFAULT_SORT_ORDER,
-            include,
-            localeCode,
-        }: Omit<GetStoriesOptions, 'pinning' | 'withHighlightedStory'> = {},
-    ) {
-        const sortOrder = getChronologicalSortOrder(order);
-        const query = JSON.stringify(getStoriesQuery(this.newsroomUuid, category.id, localeCode));
-
-        const { offset, limit } = toPaginationParams({ page, pageSize });
-
-        const { stories, pagination } = await this.searchStories({
-            limit,
-            offset,
-            sortOrder,
-            query,
-            include,
-        });
-
-        const storiesTotal = pagination.matched_records_number;
-
-        return { stories, storiesTotal };
-    }
-
-    async getStoryBySlug(slug: string) {
-        const query = JSON.stringify(getSlugQuery(this.newsroomUuid, slug));
-        const { stories } = await this.searchStories({
-            limit: 1,
-            query,
-        });
-
-        if (stories[0]) {
-            return this.getStory(stories[0].uuid);
-        }
-
-        return null;
-    }
-
-    async getCategories(): Promise<Category[]> {
-        const categories = await this.sdk.newsroomCategories.list(this.newsroomUuid, {
-            sortOrder: CATEGORIES_SORT_ORDER,
-        });
-
-        return Array.isArray(categories) ? categories : Object.values(categories);
-    }
-
-    async getCategoryBySlug(slug: string) {
-        const categories = await this.getCategories();
-
-        return categories.find((category) =>
-            Object.values(category.i18n).some((t) => t.slug === slug),
-        );
-    }
-
-    searchStories: Stories.Client['search'] = (options) => this.sdk.stories.search(options);
-
-    async getGalleries({ page, pageSize }: GetGalleriesOptions) {
-        const { offset, limit } = toPaginationParams({ page, pageSize });
-
-        return this.sdk.newsroomGalleries.search(this.newsroomUuid, {
-            limit,
-            offset,
-            scope: getGalleriesQuery(),
-        });
-    }
-
-    async getGallery(uuid: string) {
-        if (!isUuid(uuid)) {
-            // Check for legacy number ID reference, which is also supported for back-compat.
-            if (Number.isNaN(Number(uuid))) {
-                return undefined;
-            }
-        }
-
-        try {
-            const gallery = await this.sdk.newsroomGalleries.get(this.newsroomUuid, uuid);
-            return gallery;
-        } catch (error) {
-            if (isSdkError(error) && error.status === 404) {
-                return null;
-            }
-            throw error;
-        }
-    }
-
-    /**
-     * In order to prevent issues with theme preview, we only load the theme preset for a specified theme, and not the currently active one.
-     */
-    async getThemePreset() {
-        if (this.themeUuid) {
-            return this.sdk.newsroomThemes.get(this.newsroomUuid, this.themeUuid);
-        }
-
-        return null;
-    }
-
-    async getNewsroomServerSideProps(
-        request?: IncomingMessage,
-        nextLocaleIsoCode?: string,
-        story?: Story,
-    ): Promise<PageProps & ServerSidePageProps> {
-        const [newsroom, languages, categories, themePreset] = await Promise.all([
-            this.getNewsroom(),
-            this.getNewsroomLanguages(),
-            this.getCategories(),
-            this.getThemePreset(),
-        ]);
-
-        const currentLanguage = story
-            ? getLanguageFromStory(languages, story)
-            : getLanguageFromNextLocaleIsoCode(languages, nextLocaleIsoCode);
-        const defaultLanguage = getDefaultLanguage(languages);
-
-        const { code: localeCode } = currentLanguage || defaultLanguage;
-        const locale = LocaleObject.fromAnyCode(localeCode);
-
-        // TODO: if no information given for current language, show boilerplate from default language
-        const companyInformation = getCompanyInformation(languages, locale);
-
-        const notifications = getNotifications(languages, locale);
-        const algoliaSettings = getAlgoliaSettings(request);
-
-        return {
-            newsroomContextProps: {
-                newsroom,
-                companyInformation,
-                categories,
-                languages,
-                localeCode,
-                notifications,
-                themePreset,
-                algoliaSettings,
-            },
-            localeResolved: Boolean(currentLanguage),
-        };
-    }
-
-    async getNewsroomDefaultLanguage() {
-        const languages = await this.getNewsroomLanguages();
-        return getDefaultLanguage(languages);
-    }
-}

package/src/data-fetching/api/index.ts

@@ -1 +0,0 @@
-export * from './getPrezlyApi';

package/src/data-fetching/api/lib.ts

@@ -1,24 +0,0 @@
-export function toPaginationParams(params: {
-    page?: number;
-    pageSize?: number;
-    withHighlightedStory?: boolean;
-}) {
-    const { page = 1, pageSize, withHighlightedStory = false } = params;
-
-    if (!pageSize) {
-        return { offset: undefined, limit: undefined };
-    }
-
-    const offset = pageSize * (page - 1);
-    const limit = pageSize;
-
-    if (withHighlightedStory && page === 1) {
-        return { offset: 0, limit: limit + 1 };
-    }
-
-    if (withHighlightedStory && page > 1) {
-        return { offset: offset + 1, limit };
-    }
-
-    return { offset, limit };
-}

package/src/data-fetching/api/queries.ts

@@ -1,59 +0,0 @@
-import { SortOrder } from '@prezly/sdk';
-
-const publishedAndAccessible = [
-    { lifecycle_status: { $in: ['published', 'embargo'] } },
-    { visibility: { $in: ['public', 'private', 'embargo'] } },
-];
-
-const publishedAndPublic = [
-    { lifecycle_status: { $in: ['published'] } },
-    { visibility: { $in: ['public'] } },
-];
-
-export function getSlugQuery(newsroomUuid: string, slug: string) {
-    return {
-        $and: [
-            { 'newsroom.uuid': { $in: [newsroomUuid] } },
-            { slug: { $eq: slug } },
-            ...publishedAndAccessible,
-        ],
-    };
-}
-
-export function getStoriesQuery(newsroomUuid: string, categoryId?: number, localeCode?: string) {
-    const query: any = {
-        $and: [...publishedAndPublic, { 'newsroom.uuid': { $in: [newsroomUuid] } }],
-    };
-
-    if (categoryId) {
-        query.$and.push({ 'category.id': { $any: [categoryId] } });
-    }
-
-    if (localeCode) {
-        query.$and.push({ locale: { $in: [localeCode] } });
-    }
-
-    return query;
-}
-
-export function getChronologicalSortOrder(direction: `${SortOrder.Direction}`, pinning = false) {
-    const pinnedFirst = SortOrder.desc('is_pinned');
-    const chronological =
-        direction === SortOrder.Direction.ASC
-            ? SortOrder.asc('published_at')
-            : SortOrder.desc('published_at');
-
-    return pinning ? SortOrder.combine(pinnedFirst, chronological) : chronological;
-}
-
-export function getGalleriesQuery() {
-    return {
-        $and: [{ status: { $eq: 'public' } }, { images_number: { $gt: 0 } }],
-    };
-}
-
-export function getContactsQuery() {
-    return {
-        $and: [{ is_featured: { $eq: true } }],
-    };
-}

package/src/data-fetching/lib/getAlgoliaSettings.ts

@@ -1,29 +0,0 @@
-import type { IncomingMessage } from 'http';
-
-import type { AlgoliaSettings } from '../types';
-
-import { getEnvVariables } from './getEnvVariables';
-
-export function getAlgoliaSettings(req?: IncomingMessage): AlgoliaSettings {
-    if (typeof window !== 'undefined') {
-        throw new Error('"getAlgoliaSettings" should only be used on back-end side.');
-    }
-
-    // `getEnvVariables` handles both cases for envs parsing - .env and request headers
-    const {
-        ALGOLIA_API_KEY = '',
-        ALGOLIA_APP_ID = 'UI4CNRAHQB',
-        ALGOLIA_INDEX = 'public_stories_prod',
-    } = getEnvVariables(req);
-
-    if (!ALGOLIA_API_KEY) {
-        // eslint-disable-next-line no-console
-        console.error('"ALGOLIA_API_KEY" is not set in env variables. Search will not be enabled');
-    }
-
-    return {
-        ALGOLIA_API_KEY,
-        ALGOLIA_APP_ID,
-        ALGOLIA_INDEX,
-    };
-}

package/src/data-fetching/lib/getEnvVariables.ts

@@ -1,46 +0,0 @@
-import type { IncomingMessage } from 'http';
-import parseDataUrl from 'parse-data-url';
-
-import type { PrezlyEnv } from '../types';
-
-function decodeJson(json: string): Record<string, any> {
-    try {
-        const decoded = JSON.parse(json);
-        if (decoded && typeof decoded === 'object') {
-            return decoded;
-        }
-    } catch {
-        // passthru
-    }
-    return {};
-}
-
-function decodeHttpEnv(header: string): Record<string, any> {
-    if (header.startsWith('data:')) {
-        const parsed = parseDataUrl(header);
-        if (parsed && parsed.contentType === 'application/json') {
-            const data = parsed.toBuffer().toString('utf-8');
-            return decodeJson(data);
-        }
-        return {}; // unsupported data-uri
-    }
-    return decodeJson(header);
-}
-
-export function getEnvVariables<EnvType extends PrezlyEnv = PrezlyEnv>(
-    req?: IncomingMessage,
-): NodeJS.ProcessEnv & EnvType {
-    if (typeof window !== 'undefined') {
-        throw new Error('"getEnvVariables" should only be used on back-end side.');
-    }
-
-    const headerName = (process.env.HTTP_ENV_HEADER || '').toLowerCase();
-
-    if (headerName && req) {
-        const header = req.headers[headerName] as string | undefined;
-        const httpEnv = decodeHttpEnv(header || '');
-        return { ...process.env, ...httpEnv } as NodeJS.ProcessEnv & EnvType;
-    }
-
-    return { ...process.env } as NodeJS.ProcessEnv & EnvType;
-}

package/src/data-fetching/lib/index.ts

@@ -1,4 +0,0 @@
-export { getAlgoliaSettings } from './getAlgoliaSettings';
-export { getEnvVariables } from './getEnvVariables';
-export { isSdkError } from './isSdkError';
-export { isUuid } from './isUuid';

package/src/data-fetching/lib/isSdkError.ts

@@ -1,5 +0,0 @@
-import type { SdkError } from '../../types';
-
-export function isSdkError(error: any): error is SdkError {
-    return 'payload' in error;
-}

package/src/data-fetching/lib/isUuid.ts

@@ -1,5 +0,0 @@
-const UUID_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/;
-
-export function isUuid(input: string) {
-    return UUID_REGEX.test(input);
-}

package/src/data-fetching/types.ts

@@ -1,14 +0,0 @@
-export interface AlgoliaSettings {
-    ALGOLIA_API_KEY: string;
-    ALGOLIA_APP_ID: string;
-    ALGOLIA_INDEX: string;
-}
-
-export interface PrezlyNewsroomEnv {
-    PREZLY_ACCESS_TOKEN: string;
-    PREZLY_NEWSROOM_UUID: string;
-    PREZLY_THEME_UUID?: string;
-    PREZLY_MODE?: 'preview';
-}
-
-export interface PrezlyEnv extends PrezlyNewsroomEnv, AlgoliaSettings {}

package/src/intl/getFallbackLocale.ts

@@ -1,29 +0,0 @@
-import type { LangCode } from './locale';
-import { LocaleObject } from './localeObject';
-
-const localeFallback: Record<LangCode, LocaleObject[]> = {
-    en: [LocaleObject.fromAnyCode('en-US'), LocaleObject.fromAnyCode('en-GB')],
-    fr: [LocaleObject.fromAnyCode('fr-FR'), LocaleObject.fromAnyCode('fr-CA')],
-};
-
-/**
- * Fallback locales for each region independent locale.
- * For example, a story has en-CA en-AU and en-GB locales. As you can see there is no region independent locale.
- * We will use a list of possible fallbacks to determine region independent locale alias.
- * In the provided example the result will be en-GB since it is defined in the localeFallback list
- * If the list will be en-CA en-AU and en-US then the result will be en-US since it is the first one and hence takes precedence.
- */
-export function getFallbackLocale(
-    langCode: LangCode,
-    availableLocales: LocaleObject[],
-): LocaleObject | undefined {
-    const fallbacks = localeFallback[langCode];
-
-    if (!fallbacks) {
-        return undefined;
-    }
-
-    return fallbacks.find((fallback) =>
-        Boolean(availableLocales.find((available) => available.isEqual(fallback))),
-    );
-}

package/src/intl/localeConfig.js

@@ -1,23 +0,0 @@
-/**
- * This list is pulled from the main Prezly application. The underscores are replaced with dashes.
- * Together with permutation performed lower in the code,
- * the exported list represents all of the possible locale codes that Next.js theme application might accept.
- */
-const supportedLocales = require('./localeList');
-
-const lowercaseLocales = supportedLocales.map((l) => l.toLowerCase());
-
-// Get all permutations for the shorter locale codes supported by Prezly (e.g. short region codes and neutral language codes)
-const lowercaseLocalPermutations = Array.from(
-    new Set([
-        ...lowercaseLocales,
-        ...lowercaseLocales.map((code) => code.split('-')[0]),
-        ...lowercaseLocales
-            .map((code) => code.split('-')[1])
-            .filter(Boolean)
-            // Remove number-only codes from possible permutations (like `419` for `es-419`)
-            .filter((code) => Number.isNaN(Number(code))),
-    ]),
-).sort();
-
-module.exports = lowercaseLocalPermutations;

package/src/intl/localeList.js

@@ -1,110 +0,0 @@
-/**
- * This list is pulled from the main Prezly application. The underscores are replaced with dashes.
- */
-module.exports = [
-    'af-ZA',
-    'ar',
-    'ar-AE',
-    'ar-BH',
-    'ar-QA',
-    'ar-SA',
-    'az',
-    'be',
-    'bg-BG',
-    'ca',
-    'cs-CZ',
-    'da-DK',
-    'de',
-    'de-DE',
-    'de-BE',
-    'de-AT',
-    'de-CH',
-    'el-GR',
-    'en',
-    'en-US',
-    'en-AE',
-    'en-AU',
-    'en-BD',
-    'en-BE',
-    'en-BH',
-    'en-CA',
-    'en-CN',
-    'en-DE',
-    'en-DK',
-    'en-GB',
-    'en-HK',
-    'en-ID',
-    'en-IE',
-    'en-IL',
-    'en-IN',
-    'en-JM',
-    'en-JP',
-    'en-KH',
-    'en-KR',
-    'en-LK',
-    'en-MV',
-    'en-MM',
-    'en-MY',
-    'en-NP',
-    'en-NZ',
-    'en-PH',
-    'en-PK',
-    'en-QA',
-    'en-SA',
-    'en-SG',
-    'en-TH',
-    'en-TW',
-    'en-VN',
-    'en-ZA',
-    'es',
-    'es-ES',
-    'es-MX',
-    'et-EE',
-    'es-419',
-    'fi-FI',
-    'fil',
-    'fr',
-    'fr-BE',
-    'fr-FR',
-    'fr-CA',
-    'fr-LU',
-    'ga-IE',
-    'he-IL',
-    'hi-IN',
-    'hr-HR',
-    'hu-HU',
-    'id-ID',
-    'it-IT',
-    'ja-JP',
-    'kk',
-    'ko-KR',
-    'ky',
-    'lt-LT',
-    'lv-LV',
-    'mt-MT',
-    'ms-MY',
-    'nb-NO',
-    'nl',
-    'nl-BE',
-    'nl-NL',
-    'pl-PL',
-    'pt',
-    'pt-BR',
-    'pt-PT',
-    'ro-RO',
-    'ru-RU',
-    'sk-SK',
-    'sl-SI',
-    'sv-SE',
-    'sw',
-    'th-TH',
-    'tr-TR',
-    'uk-UA',
-    'ur-PK',
-    'uz',
-    'vi-VN',
-    'zh-Hant',
-    'zh-HK',
-    'zh-TW',
-    'zh-CN',
-];