@prezly/theme-kit-nextjs 4.2.0-alpha.2 → 4.2.0-alpha.4

package/src/adapter-nextjs/getNewsroomStaticProps.ts

@@ -1,29 +0,0 @@
-import type { Story } from '@prezly/sdk';
-import type { GetStaticPropsContext } from 'next';
-
-import { getNextPrezlyApi } from '../data-fetching';
-
-interface Options {
-    loadHomepageContacts?: boolean;
-    story?: Story;
-}
-
-/**
- * Use this function in your `getNewsroomStaticProps` page methods to retrieve the data necessary for the NewsroomContextProvider and `processRequest` function.
- * See README for usage examples.
- */
-export async function getNewsroomStaticProps(
-    context: GetStaticPropsContext,
-    options: Options = {},
-) {
-    const { locale } = context;
-
-    const api = getNextPrezlyApi();
-    const staticProps = await api.getNewsroomServerSideProps(undefined, locale, options.story);
-
-    if (options.loadHomepageContacts) {
-        staticProps.newsroomContextProps.contacts = await api.getNewsroomContacts();
-    }
-
-    return { api, staticProps };
-}

package/src/adapter-nextjs/index.ts

@@ -1,6 +0,0 @@
-export * from './api-handlers';
-export * from './getNewsroomServerSideProps';
-export * from './getNewsroomStaticProps';
-export * from './page-props';
-export * from './processRequest';
-export * from './processStaticRequest';

package/src/adapter-nextjs/page-props/category.ts

@@ -1,156 +0,0 @@
-import type { Story } from '@prezly/sdk';
-import { DEFAULT_PAGE_SIZE, getLocalizedCategoryData, LocaleObject } from '@prezly/theme-kit-core';
-import type {
-    GetServerSidePropsContext,
-    GetServerSidePropsResult,
-    GetStaticPathsResult,
-    GetStaticPropsContext,
-    GetStaticPropsResult,
-} from 'next';
-
-import { getNextPrezlyApi } from '../../data-fetching';
-import type { PaginationProps } from '../../infinite-loading/types';
-import { getNewsroomServerSideProps } from '../getNewsroomServerSideProps';
-import { getNewsroomStaticProps } from '../getNewsroomStaticProps';
-import { processRequest } from '../processRequest';
-import { processStaticRequest } from '../processStaticRequest';
-
-import type { PropsFunction } from './lib/types';
-
-export interface CategoryPageProps<StoryType extends Story = Story> {
-    stories: StoryType[];
-    pagination: PaginationProps;
-}
-
-interface Options {
-    extraStoryFields?: (keyof Story.ExtraFields)[];
-    pageSize?: number;
-}
-
-export function getCategoryPageServerSideProps<
-    CustomProps extends Record<string, any>,
-    StoryType extends Story = Story,
->(customProps: CustomProps | PropsFunction<CustomProps>, options?: Options) {
-    const { pageSize = DEFAULT_PAGE_SIZE, extraStoryFields } = options || {};
-
-    return async function getServerSideProps(
-        context: GetServerSidePropsContext,
-    ): Promise<GetServerSidePropsResult<CategoryPageProps<StoryType> & CustomProps>> {
-        const { api, serverSideProps } = await getNewsroomServerSideProps(context);
-
-        const { slug } = context.params as { slug: string };
-        const category = await api.getCategoryBySlug(slug);
-
-        if (!category) {
-            return {
-                notFound: true,
-            };
-        }
-
-        const { query } = context;
-        const page = query.page && typeof query.page === 'string' ? Number(query.page) : undefined;
-
-        const { localeCode } = serverSideProps.newsroomContextProps;
-
-        const { stories, storiesTotal } = await api.getStoriesFromCategory(category, {
-            page,
-            pageSize,
-            include: extraStoryFields,
-            localeCode,
-        });
-
-        serverSideProps.newsroomContextProps.currentCategory = category;
-
-        return processRequest(
-            context,
-            {
-                ...serverSideProps,
-                // TODO: This is temporary until return types from API are figured out
-                stories: stories as StoryType[],
-                pagination: {
-                    itemsTotal: storiesTotal,
-                    currentPage: page ?? 1,
-                    pageSize,
-                },
-                ...(typeof customProps === 'function'
-                    ? await (customProps as PropsFunction<CustomProps>)(context, serverSideProps)
-                    : customProps),
-            },
-            `/category/${slug}`,
-        );
-    };
-}
-
-export function getCategoryPageStaticProps<
-    CustomProps extends Record<string, any>,
-    StoryType extends Story = Story,
->(customProps: CustomProps | PropsFunction<CustomProps, GetStaticPropsContext>, options?: Options) {
-    const { pageSize = DEFAULT_PAGE_SIZE, extraStoryFields } = options || {};
-
-    return async function getStaticProps(
-        context: GetStaticPropsContext,
-    ): Promise<GetStaticPropsResult<CategoryPageProps<StoryType> & CustomProps>> {
-        const { api, staticProps } = await getNewsroomStaticProps(context);
-
-        const { slug } = context.params as { slug: string };
-        const category = await api.getCategoryBySlug(slug);
-
-        if (!category) {
-            return {
-                notFound: true,
-            };
-        }
-
-        const { localeCode } = staticProps.newsroomContextProps;
-
-        const { stories, storiesTotal } = await api.getStoriesFromCategory(category, {
-            pageSize,
-            include: extraStoryFields,
-            localeCode,
-        });
-
-        staticProps.newsroomContextProps.currentCategory = category;
-
-        return processStaticRequest(context, {
-            ...staticProps,
-            // TODO: This is temporary until return types from API are figured out
-            stories: stories as StoryType[],
-            pagination: {
-                itemsTotal: storiesTotal,
-                currentPage: 1,
-                pageSize,
-            },
-            ...(typeof customProps === 'function'
-                ? await (customProps as PropsFunction<CustomProps, GetStaticPropsContext>)(
-                      context,
-                      staticProps,
-                  )
-                : customProps),
-        });
-    };
-}
-
-export async function getCategoryPageStaticPaths(): Promise<GetStaticPathsResult> {
-    const api = getNextPrezlyApi();
-    const [categories, defaultLanguage] = await Promise.all([
-        api.getCategories(),
-        api.getNewsroomDefaultLanguage(),
-    ]);
-    const locale = LocaleObject.fromAnyCode(defaultLanguage.code);
-
-    const paths = categories
-        .map((category) => {
-            const { slug } = getLocalizedCategoryData(category, locale);
-            if (!slug) {
-                return undefined;
-            }
-
-            return { params: { slug } };
-        })
-        .filter<{ params: { slug: string } }>(Boolean as any);
-
-    return {
-        paths,
-        fallback: 'blocking',
-    };
-}

package/src/adapter-nextjs/page-props/gallery.ts

@@ -1,114 +0,0 @@
-import type { NewsroomGallery } from '@prezly/sdk';
-import { DEFAULT_GALLERY_PAGE_SIZE } from '@prezly/theme-kit-core';
-import type {
-    GetServerSidePropsContext,
-    GetServerSidePropsResult,
-    GetStaticPropsContext,
-    GetStaticPropsResult,
-} from 'next';
-
-import type { PaginationProps } from '../../infinite-loading/types';
-import { getNewsroomServerSideProps } from '../getNewsroomServerSideProps';
-import { getNewsroomStaticProps } from '../getNewsroomStaticProps';
-import { processRequest } from '../processRequest';
-import { processStaticRequest } from '../processStaticRequest';
-
-import type { PropsFunction } from './lib/types';
-
-export interface GalleryPageProps {
-    galleries: NewsroomGallery[];
-    pagination: PaginationProps;
-}
-
-interface Options {
-    pageSize?: number;
-}
-
-export function getGalleryPageServerSideProps<CustomProps extends Record<string, any>>(
-    customProps: CustomProps | PropsFunction<CustomProps>,
-    options?: Options,
-) {
-    const { pageSize = DEFAULT_GALLERY_PAGE_SIZE } = options || {};
-
-    return async function getServerSideProps(
-        context: GetServerSidePropsContext,
-    ): Promise<GetServerSidePropsResult<GalleryPageProps & CustomProps>> {
-        const { api, serverSideProps } = await getNewsroomServerSideProps(context);
-        const { query } = context;
-
-        const page = query.page && typeof query.page === 'string' ? Number(query.page) : undefined;
-        const { galleries, pagination } = await api.getGalleries({ page, pageSize });
-
-        // If there's only one gallery, redirect to it immediately
-        if (galleries.length === 1) {
-            const { uuid } = galleries[0];
-
-            return {
-                redirect: {
-                    destination: `/media/album/${uuid}`,
-                    permanent: false,
-                },
-            };
-        }
-
-        return processRequest(
-            context,
-            {
-                ...serverSideProps,
-                galleries,
-                pagination: {
-                    itemsTotal: pagination.matched_records_number,
-                    currentPage: page ?? 1,
-                    pageSize,
-                },
-                ...(typeof customProps === 'function'
-                    ? await (customProps as PropsFunction<CustomProps>)(context, serverSideProps)
-                    : customProps),
-            },
-            '/media',
-        );
-    };
-}
-
-export function getGalleryPageStaticProps<CustomProps extends Record<string, any>>(
-    customProps: CustomProps | PropsFunction<CustomProps, GetStaticPropsContext>,
-    options?: Options,
-) {
-    const { pageSize = DEFAULT_GALLERY_PAGE_SIZE } = options || {};
-
-    return async function getStaticProps(
-        context: GetStaticPropsContext,
-    ): Promise<GetStaticPropsResult<GalleryPageProps & CustomProps>> {
-        const { api, staticProps } = await getNewsroomStaticProps(context);
-
-        const { galleries, pagination } = await api.getGalleries({ pageSize });
-
-        // If there's only one gallery, redirect to it immediately
-        if (galleries.length === 1) {
-            const { uuid } = galleries[0];
-
-            return {
-                redirect: {
-                    destination: `/media/album/${uuid}`,
-                    permanent: false,
-                },
-            };
-        }
-
-        return processStaticRequest(context, {
-            ...staticProps,
-            galleries,
-            pagination: {
-                itemsTotal: pagination.matched_records_number,
-                currentPage: 1,
-                pageSize,
-            },
-            ...(typeof customProps === 'function'
-                ? await (customProps as PropsFunction<CustomProps, GetStaticPropsContext>)(
-                      context,
-                      staticProps,
-                  )
-                : customProps),
-        });
-    };
-}

package/src/adapter-nextjs/page-props/galleryAlbum.ts

@@ -1,89 +0,0 @@
-import type { NewsroomGallery } from '@prezly/sdk';
-import type {
-    GetServerSidePropsContext,
-    GetServerSidePropsResult,
-    GetStaticPathsResult,
-    GetStaticPropsContext,
-    GetStaticPropsResult,
-} from 'next';
-
-import { getNextPrezlyApi } from '../../data-fetching';
-import { getNewsroomServerSideProps } from '../getNewsroomServerSideProps';
-import { getNewsroomStaticProps } from '../getNewsroomStaticProps';
-import { processRequest } from '../processRequest';
-import { processStaticRequest } from '../processStaticRequest';
-
-import type { PropsFunction } from './lib/types';
-
-export interface GalleryAlbumPageProps {
-    gallery: NewsroomGallery;
-}
-
-export function getGalleryAlbumPageServerSideProps<CustomProps extends Record<string, any>>(
-    customProps: CustomProps | PropsFunction<CustomProps>,
-) {
-    return async function getServerSideProps(
-        context: GetServerSidePropsContext,
-    ): Promise<GetServerSidePropsResult<GalleryAlbumPageProps & CustomProps>> {
-        const { api, serverSideProps } = await getNewsroomServerSideProps(context);
-
-        const { uuid } = context.params as { uuid: string };
-        const gallery = await api.getGallery(uuid);
-
-        if (!gallery || !gallery.images_number) {
-            return { notFound: true };
-        }
-
-        return processRequest(
-            context,
-            {
-                ...serverSideProps,
-                gallery,
-                ...(typeof customProps === 'function'
-                    ? await (customProps as PropsFunction<CustomProps>)(context, serverSideProps)
-                    : customProps),
-            },
-            `/media/album/${uuid}`,
-        );
-    };
-}
-
-export function getGalleryAlbumPageStaticProps<CustomProps extends Record<string, any>>(
-    customProps: CustomProps | PropsFunction<CustomProps, GetStaticPropsContext>,
-) {
-    return async function getStaticProps(
-        context: GetStaticPropsContext,
-    ): Promise<GetStaticPropsResult<GalleryAlbumPageProps & CustomProps>> {
-        const { api, staticProps } = await getNewsroomStaticProps(context);
-
-        const { uuid } = context.params as { uuid: string };
-        const gallery = await api.getGallery(uuid);
-
-        if (!gallery || !gallery.images_number) {
-            return { notFound: true };
-        }
-
-        return processStaticRequest(context, {
-            ...staticProps,
-            gallery,
-            ...(typeof customProps === 'function'
-                ? await (customProps as PropsFunction<CustomProps, GetStaticPropsContext>)(
-                      context,
-                      staticProps,
-                  )
-                : customProps),
-        });
-    };
-}
-
-export async function getGalleryAlbumPageStaticPaths(): Promise<GetStaticPathsResult> {
-    const api = getNextPrezlyApi();
-    const { galleries } = await api.getGalleries({});
-
-    const paths = galleries.map(({ uuid }) => ({ params: { uuid } }));
-
-    return {
-        paths,
-        fallback: 'blocking',
-    };
-}

package/src/adapter-nextjs/page-props/home.ts

@@ -1,131 +0,0 @@
-import type { Story } from '@prezly/sdk';
-import { DEFAULT_PAGE_SIZE } from '@prezly/theme-kit-core';
-import type {
-    GetServerSidePropsContext,
-    GetServerSidePropsResult,
-    GetStaticPropsContext,
-    GetStaticPropsResult,
-} from 'next';
-
-import type { PaginationProps } from '../../infinite-loading/types';
-import { getNewsroomServerSideProps } from '../getNewsroomServerSideProps';
-import { getNewsroomStaticProps } from '../getNewsroomStaticProps';
-import { processRequest } from '../processRequest';
-import { processStaticRequest } from '../processStaticRequest';
-
-import type { PropsFunction } from './lib/types';
-
-export interface HomePageProps<StoryType extends Story = Story> {
-    stories: StoryType[];
-    pagination: PaginationProps;
-}
-
-interface Options {
-    extraStoryFields?: (keyof Story.ExtraFields)[];
-    /**
-     * When set to `true`, the initial `stories` array 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;
-    pageSize?: number;
-    pinning?: boolean;
-    filterQuery?: Object;
-}
-
-export function getHomepageServerSideProps<
-    CustomProps extends Record<string, any>,
-    StoryType extends Story = Story,
->(customProps: CustomProps | PropsFunction<CustomProps>, options?: Options) {
-    const {
-        pageSize = DEFAULT_PAGE_SIZE,
-        extraStoryFields,
-        pinning = false,
-        withHighlightedStory = false,
-        filterQuery,
-    } = options || {};
-
-    return async function getServerSideProps(
-        context: GetServerSidePropsContext,
-    ): Promise<GetServerSidePropsResult<HomePageProps<StoryType> & CustomProps>> {
-        const { api, serverSideProps } = await getNewsroomServerSideProps(context, {
-            loadHomepageContacts: true,
-        });
-
-        const { query } = context;
-        const page = query.page && typeof query.page === 'string' ? Number(query.page) : undefined;
-
-        const { localeCode } = serverSideProps.newsroomContextProps;
-
-        const storiesPaginated = await api.getStories({
-            page,
-            pageSize,
-            pinning,
-            include: extraStoryFields,
-            localeCode,
-            withHighlightedStory,
-            filterQuery,
-        });
-        const { stories, storiesTotal } = storiesPaginated;
-
-        return processRequest(
-            context,
-            {
-                ...serverSideProps,
-                // TODO: This is temporary until return types from API are figured out
-                stories: stories as StoryType[],
-                pagination: {
-                    itemsTotal: storiesTotal,
-                    currentPage: page ?? 1,
-                    pageSize,
-                    withHighlightedStory,
-                },
-                ...(typeof customProps === 'function'
-                    ? await (customProps as PropsFunction<CustomProps>)(context, serverSideProps)
-                    : customProps),
-            },
-            '/',
-        );
-    };
-}
-
-export function getHomepageStaticProps<
-    CustomProps extends Record<string, any>,
-    StoryType extends Story = Story,
->(customProps: CustomProps | PropsFunction<CustomProps, GetStaticPropsContext>, options?: Options) {
-    const { pageSize = DEFAULT_PAGE_SIZE, extraStoryFields, pinning = false } = options || {};
-
-    return async function getStaticProps(
-        context: GetStaticPropsContext,
-    ): Promise<GetStaticPropsResult<HomePageProps<StoryType> & CustomProps>> {
-        const { api, staticProps } = await getNewsroomStaticProps(context, {
-            loadHomepageContacts: true,
-        });
-
-        const { localeCode } = staticProps.newsroomContextProps;
-
-        const storiesPaginated = await api.getStories({
-            pageSize,
-            pinning,
-            include: extraStoryFields,
-            localeCode,
-        });
-        const { stories, storiesTotal } = storiesPaginated;
-
-        return processStaticRequest(context, {
-            ...staticProps,
-            // TODO: This is temporary until return types from API are figured out
-            stories: stories as StoryType[],
-            pagination: {
-                itemsTotal: storiesTotal,
-                currentPage: 1,
-                pageSize,
-            },
-            ...(typeof customProps === 'function'
-                ? await (customProps as PropsFunction<CustomProps, GetStaticPropsContext>)(
-                      context,
-                      staticProps,
-                  )
-                : customProps),
-        });
-    };
-}

package/src/adapter-nextjs/page-props/index.ts

@@ -1,26 +0,0 @@
-export {
-    getCategoryPageServerSideProps,
-    getCategoryPageStaticPaths,
-    getCategoryPageStaticProps,
-    type CategoryPageProps,
-} from './category';
-export {
-    getGalleryPageServerSideProps,
-    getGalleryPageStaticProps,
-    type GalleryPageProps,
-} from './gallery';
-export {
-    getGalleryAlbumPageServerSideProps,
-    getGalleryAlbumPageStaticPaths,
-    getGalleryAlbumPageStaticProps,
-    type GalleryAlbumPageProps,
-} from './galleryAlbum';
-export { getHomepageServerSideProps, getHomepageStaticProps, type HomePageProps } from './home';
-export { getSearchPageServerSideProps, getSearchPageStaticProps } from './search';
-export * from './sitemap';
-export {
-    getStoryPageServerSideProps,
-    getStoryPageStaticPaths,
-    getStoryPageStaticProps,
-} from './story';
-export { getStoryPreviewPageServerSideProps } from './storyPreview';

package/src/adapter-nextjs/page-props/lib/types.ts

@@ -1,8 +0,0 @@
-import type { GetServerSidePropsContext, GetStaticPropsContext } from 'next';
-
-import type { PageProps } from '../../../types';
-
-export type PropsFunction<
-    CustomProps,
-    Context extends GetServerSidePropsContext | GetStaticPropsContext = GetServerSidePropsContext,
-> = (context: Context, props: PageProps) => CustomProps | Promise<CustomProps>;

package/src/adapter-nextjs/page-props/search.ts

@@ -1,53 +0,0 @@
-import type {
-    GetServerSidePropsContext,
-    GetServerSidePropsResult,
-    GetStaticPropsContext,
-} from 'next';
-
-import { getNewsroomServerSideProps } from '../getNewsroomServerSideProps';
-import { getNewsroomStaticProps } from '../getNewsroomStaticProps';
-import { processRequest } from '../processRequest';
-import { processStaticRequest } from '../processStaticRequest';
-
-import type { PropsFunction } from './lib/types';
-
-export function getSearchPageServerSideProps<CustomProps extends Record<string, any>>(
-    customProps: CustomProps | PropsFunction<CustomProps>,
-) {
-    return async function getServerSideProps(
-        context: GetServerSidePropsContext,
-    ): Promise<GetServerSidePropsResult<CustomProps>> {
-        const { serverSideProps } = await getNewsroomServerSideProps(context);
-
-        return processRequest(
-            context,
-            {
-                ...serverSideProps,
-                ...(typeof customProps === 'function'
-                    ? await (customProps as PropsFunction<CustomProps>)(context, serverSideProps)
-                    : customProps),
-            },
-            '/search',
-        );
-    };
-}
-
-export function getSearchPageStaticProps<CustomProps extends Record<string, any>>(
-    customProps: CustomProps | PropsFunction<CustomProps, GetStaticPropsContext>,
-) {
-    return async function getStaticProps(
-        context: GetServerSidePropsContext,
-    ): Promise<GetServerSidePropsResult<CustomProps>> {
-        const { staticProps } = await getNewsroomStaticProps(context);
-
-        return processStaticRequest(context, {
-            ...staticProps,
-            ...(typeof customProps === 'function'
-                ? await (customProps as PropsFunction<CustomProps, GetStaticPropsContext>)(
-                      context,
-                      staticProps,
-                  )
-                : customProps),
-        });
-    };
-}

package/src/adapter-nextjs/page-props/sitemap/SitemapBuilder.ts

@@ -1,56 +0,0 @@
-import type { SitemapUrl } from './types';
-
-export class SitemapBuilder {
-    private baseUrl: string;
-
-    private urls: SitemapUrl[] = [];
-
-    constructor(baseUrl: string) {
-        this.baseUrl = baseUrl;
-    }
-
-    public addUrl(location: string) {
-        this.urls.push({
-            location: this.baseUrl + location,
-            changeFrequency: SitemapBuilder.guessFrequency(location),
-            priority: SitemapBuilder.guessPriority(location),
-        });
-    }
-
-    private static guessFrequency(location: string) {
-        if (location === '/') return 'daily';
-
-        return 'weekly';
-    }
-
-    private static guessPriority(location: string) {
-        if (location === '/') return '0.9';
-
-        if (location.startsWith('/category/')) {
-            return '0.8';
-        }
-
-        return '0.7';
-    }
-
-    static serializeLocation(url: SitemapUrl) {
-        return [
-            '<url>',
-            url.location && `\t<loc>${url.location}</loc>`,
-            url.changeFrequency && `\t<changefreq>${url.changeFrequency}</changefreq>`,
-            url.priority && `\t<priority>${url.priority}</priority>`,
-            '</url>',
-        ]
-            .filter(Boolean)
-            .join('\n');
-    }
-
-    serialize() {
-        return [
-            '<?xml version="1.0" encoding="UTF-8" ?>',
-            '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:news="http://www.google.com/schemas/sitemap-news/0.9" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1">',
-            this.urls.map(SitemapBuilder.serializeLocation).join('\n'),
-            '</urlset>',
-        ].join('\n');
-    }
-}