@prezly/theme-kit-nextjs 2.0.0-0 → 2.0.0-2

package/README.md

@@ -69,26 +69,21 @@ module.exports = {
 If you want to support multi-language in your theme, you'll need to make additional changes to the file:
 
 ```js
-const { DUMMY_DEFAULT_LOCALE } = require('@prezly/theme-kit-nextjs');
-const locales = require('@prezly/theme-kit-nextjs/build/intl/localeConfig');
+const { localeConfig } = require('@prezly/theme-kit-nextjs/localeConfig');
 
 module.exports = {
     /* ...your next config... */
 
-    i18n: {
-        // These are all the locales you want to support in
-        // your application
-        locales: [...locales, DUMMY_DEFAULT_LOCALE],
-        // This is the default locale you want to be used when visiting
-        // a non-locale prefixed path e.g. `/media`
-        // We use Pseudo locale used for localization testing, to reliably determine if we need to fallback to the default newsroom language
-        defaultLocale: DUMMY_DEFAULT_LOCALE,
-        // Default locale detection is disabled, since the locales would be determined by Prezly API
-        localeDetection: false,
-    },
+    i18n: localeConfig,
 };
 ```
 
+The `localeConfig` sets three properties on `i18n` configuration:
+
+* `locales` - These are all locales that Prezly Theme can support
+* `defaultLocale` - A pseudo locale used for localization testing, to reliably determine if we need to fallback to the default newsroom language. This is needed for internal locale resolution in the Theme Kit
+* `localeDetection` is set to `false`, since the locales would be determined by Prezly API    
+
 ### pages/_app.tsx
 
 In order to provide all the necessary data to the entire application, this library exports the `NewsroomContextProvider` component, which accepts props retrieved by our data-fetching methods (see next section). These props contain data that would be required to display common components like navigation, language picker, boilerplate, etc.

package/build/@types/global.d.js

@@ -0,0 +1 @@
+export {};

package/build/adapter-nextjs/api-handlers/fetchGalleries.js

@@ -1,19 +1,27 @@
-import { getPrezlyApi } from '../../data-fetching';
+import { getPrezlyApi } from "../../data-fetching/index.js";
 export async function fetchGalleries(req, res) {
-    if (req.method !== 'POST') {
-        res.status(405);
-        return;
-    }
-    const { page, pageSize } = req.body;
-    try {
-        const api = getPrezlyApi(req);
-        const { galleries } = await api.getGalleries({ page, pageSize });
-        res.status(200).json({ galleries });
-    }
-    catch (error) {
-        res.status(500).send({
-            message: error.message,
-        });
-    }
-}
-//# sourceMappingURL=fetchGalleries.js.map
+  if (req.method !== 'POST') {
+    res.status(405);
+    return;
+  }
+  const {
+    page,
+    pageSize
+  } = req.body;
+  try {
+    const api = getPrezlyApi(req);
+    const {
+      galleries
+    } = await api.getGalleries({
+      page,
+      pageSize
+    });
+    res.status(200).json({
+      galleries
+    });
+  } catch (error) {
+    res.status(500).send({
+      message: error.message
+    });
+  }
+}

package/build/adapter-nextjs/api-handlers/fetchStories.js

@@ -1,21 +1,37 @@
-import { getPrezlyApi } from '../../data-fetching';
+import { getPrezlyApi } from "../../data-fetching/index.js";
 export async function fetchStories(req, res) {
-    if (req.method !== 'POST') {
-        res.status(405);
-        return;
-    }
-    const { page, pageSize, category, include, localeCode } = req.body;
-    try {
-        const api = getPrezlyApi(req);
-        const { stories } = await (category
-            ? api.getStoriesFromCategory(category, { page, pageSize, include, localeCode })
-            : api.getStories({ page, pageSize, include, localeCode }));
-        res.status(200).json({ stories });
-    }
-    catch (error) {
-        res.status(500).send({
-            message: error.message,
-        });
-    }
-}
-//# sourceMappingURL=fetchStories.js.map
+  if (req.method !== 'POST') {
+    res.status(405);
+    return;
+  }
+  const {
+    page,
+    pageSize,
+    category,
+    include,
+    localeCode
+  } = req.body;
+  try {
+    const api = getPrezlyApi(req);
+    const {
+      stories
+    } = await (category ? api.getStoriesFromCategory(category, {
+      page,
+      pageSize,
+      include,
+      localeCode
+    }) : api.getStories({
+      page,
+      pageSize,
+      include,
+      localeCode
+    }));
+    res.status(200).json({
+      stories
+    });
+  } catch (error) {
+    res.status(500).send({
+      message: error.message
+    });
+  }
+}

package/build/adapter-nextjs/api-handlers/index.js

@@ -1,3 +1,2 @@
-export { fetchGalleries } from './fetchGalleries';
-export { fetchStories } from './fetchStories';
-//# sourceMappingURL=index.js.map
+export { fetchGalleries } from "./fetchGalleries.js";
+export { fetchStories } from "./fetchStories.js";

package/build/adapter-nextjs/getNewsroomServerSideProps.js

@@ -1,15 +1,20 @@
-import { getPrezlyApi } from '../data-fetching';
+import { getPrezlyApi } from "../data-fetching/index.js";
 /**
  * Use this function in your `getServerSideProps` page methods to retrieve the data necessary for the NewsroomContextProvider and `processRequest` function.
  * See README for usage examples.
  */
 export async function getNewsroomServerSideProps(context, options = {}) {
-    const { req: request, locale } = context;
-    const api = getPrezlyApi(request);
-    const serverSideProps = await api.getNewsroomServerSideProps(request, locale, options.story);
-    if (options.loadHomepageContacts) {
-        serverSideProps.newsroomContextProps.contacts = await api.getNewsroomContacts();
-    }
-    return { api, serverSideProps };
-}
-//# sourceMappingURL=getNewsroomServerSideProps.js.map
+  const {
+    req: request,
+    locale
+  } = context;
+  const api = getPrezlyApi(request);
+  const serverSideProps = await api.getNewsroomServerSideProps(request, locale, options.story);
+  if (options.loadHomepageContacts) {
+    serverSideProps.newsroomContextProps.contacts = await api.getNewsroomContacts();
+  }
+  return {
+    api,
+    serverSideProps
+  };
+}

package/build/adapter-nextjs/getNewsroomStaticProps.js

@@ -1,15 +1,19 @@
-import { getPrezlyApi } from '../data-fetching';
+import { getPrezlyApi } from "../data-fetching/index.js";
 /**
  * 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, options = {}) {
-    const { locale } = context;
-    const api = getPrezlyApi();
-    const staticProps = await api.getNewsroomServerSideProps(undefined, locale, options.story);
-    if (options.loadHomepageContacts) {
-        staticProps.newsroomContextProps.contacts = await api.getNewsroomContacts();
-    }
-    return { api, staticProps };
-}
-//# sourceMappingURL=getNewsroomStaticProps.js.map
+  const {
+    locale
+  } = context;
+  const api = getPrezlyApi();
+  const staticProps = await api.getNewsroomServerSideProps(undefined, locale, options.story);
+  if (options.loadHomepageContacts) {
+    staticProps.newsroomContextProps.contacts = await api.getNewsroomContacts();
+  }
+  return {
+    api,
+    staticProps
+  };
+}

package/build/adapter-nextjs/index.js

@@ -1,7 +1,6 @@
-export * from './api-handlers';
-export * from './getNewsroomServerSideProps';
-export * from './getNewsroomStaticProps';
-export * from './page-props';
-export * from './processRequest';
-export * from './processStaticRequest';
-//# sourceMappingURL=index.js.map
+export * from "./api-handlers/index.js";
+export * from "./getNewsroomServerSideProps.js";
+export * from "./getNewsroomStaticProps.js";
+export * from "./page-props/index.js";
+export * from "./processRequest.js";
+export * from "./processStaticRequest.js";

package/build/adapter-nextjs/page-props/category.js

@@ -1,98 +1,122 @@
-import { getPrezlyApi } from '../../data-fetching';
-import { LocaleObject } from '../../intl';
-import { DEFAULT_PAGE_SIZE, getLocalizedCategoryData } from '../../utils';
-import { getNewsroomServerSideProps } from '../getNewsroomServerSideProps';
-import { getNewsroomStaticProps } from '../getNewsroomStaticProps';
-import { processRequest } from '../processRequest';
-import { processStaticRequest } from '../processStaticRequest';
+import { getPrezlyApi } from "../../data-fetching/index.js";
+import { LocaleObject } from "../../intl/index.js";
+import { DEFAULT_PAGE_SIZE, getLocalizedCategoryData } from "../../utils/index.js";
+import { getNewsroomServerSideProps } from "../getNewsroomServerSideProps.js";
+import { getNewsroomStaticProps } from "../getNewsroomStaticProps.js";
+import { processRequest } from "../processRequest.js";
+import { processStaticRequest } from "../processStaticRequest.js";
 export function getCategoryPageServerSideProps(customProps, options) {
-    const { pageSize = DEFAULT_PAGE_SIZE, extraStoryFields } = options || {};
-    return async function getServerSideProps(context) {
-        const { api, serverSideProps } = await getNewsroomServerSideProps(context);
-        const { slug } = context.params;
-        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,
-            pagination: {
-                itemsTotal: storiesTotal,
-                currentPage: page ?? 1,
-                pageSize,
-            },
-            ...(typeof customProps === 'function'
-                ? await customProps(context, serverSideProps)
-                : customProps),
-        }, `/category/${slug}`);
-    };
+  const {
+    pageSize = DEFAULT_PAGE_SIZE,
+    extraStoryFields
+  } = options || {};
+  return async function getServerSideProps(context) {
+    const {
+      api,
+      serverSideProps
+    } = await getNewsroomServerSideProps(context);
+    const {
+      slug
+    } = context.params;
+    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,
+      pagination: {
+        itemsTotal: storiesTotal,
+        currentPage: page ?? 1,
+        pageSize
+      },
+      ...(typeof customProps === 'function' ? await customProps(context, serverSideProps) : customProps)
+    }, `/category/${slug}`);
+  };
 }
 export function getCategoryPageStaticProps(customProps, options) {
-    const { pageSize = DEFAULT_PAGE_SIZE, extraStoryFields } = options || {};
-    return async function getStaticProps(context) {
-        const { api, staticProps } = await getNewsroomStaticProps(context);
-        const { slug } = context.params;
-        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,
-            pagination: {
-                itemsTotal: storiesTotal,
-                currentPage: 1,
-                pageSize,
-            },
-            ...(typeof customProps === 'function'
-                ? await customProps(context, staticProps)
-                : customProps),
-        });
-    };
+  const {
+    pageSize = DEFAULT_PAGE_SIZE,
+    extraStoryFields
+  } = options || {};
+  return async function getStaticProps(context) {
+    const {
+      api,
+      staticProps
+    } = await getNewsroomStaticProps(context);
+    const {
+      slug
+    } = context.params;
+    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,
+      pagination: {
+        itemsTotal: storiesTotal,
+        currentPage: 1,
+        pageSize
+      },
+      ...(typeof customProps === 'function' ? await customProps(context, staticProps) : customProps)
+    });
+  };
 }
 export async function getCategoryPageStaticPaths() {
-    const api = getPrezlyApi();
-    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(Boolean);
+  const api = getPrezlyApi();
+  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 {
-        paths,
-        fallback: 'blocking',
+      params: {
+        slug
+      }
     };
-}
-//# sourceMappingURL=category.js.map
+  }).filter(Boolean);
+  return {
+    paths,
+    fallback: 'blocking'
+  };
+}

package/build/adapter-nextjs/page-props/gallery.js

@@ -1,66 +1,90 @@
-import { DEFAULT_GALLERY_PAGE_SIZE } from '../../utils';
-import { getNewsroomServerSideProps } from '../getNewsroomServerSideProps';
-import { getNewsroomStaticProps } from '../getNewsroomStaticProps';
-import { processRequest } from '../processRequest';
-import { processStaticRequest } from '../processStaticRequest';
+import { DEFAULT_GALLERY_PAGE_SIZE } from "../../utils/index.js";
+import { getNewsroomServerSideProps } from "../getNewsroomServerSideProps.js";
+import { getNewsroomStaticProps } from "../getNewsroomStaticProps.js";
+import { processRequest } from "../processRequest.js";
+import { processStaticRequest } from "../processStaticRequest.js";
 export function getGalleryPageServerSideProps(customProps, options) {
-    const { pageSize = DEFAULT_GALLERY_PAGE_SIZE } = options || {};
-    return async function getServerSideProps(context) {
-        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,
-                },
-            };
+  const {
+    pageSize = DEFAULT_GALLERY_PAGE_SIZE
+  } = options || {};
+  return async function getServerSideProps(context) {
+    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(context, serverSideProps)
-                : customProps),
-        }, '/media');
-    };
+      };
+    }
+    return processRequest(context, {
+      ...serverSideProps,
+      galleries,
+      pagination: {
+        itemsTotal: pagination.matched_records_number,
+        currentPage: page ?? 1,
+        pageSize
+      },
+      ...(typeof customProps === 'function' ? await customProps(context, serverSideProps) : customProps)
+    }, '/media');
+  };
 }
 export function getGalleryPageStaticProps(customProps, options) {
-    const { pageSize = DEFAULT_GALLERY_PAGE_SIZE } = options || {};
-    return async function getStaticProps(context) {
-        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,
-                },
-            };
+  const {
+    pageSize = DEFAULT_GALLERY_PAGE_SIZE
+  } = options || {};
+  return async function getStaticProps(context) {
+    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(context, staticProps)
-                : customProps),
-        });
-    };
-}
-//# sourceMappingURL=gallery.js.map
+      };
+    }
+    return processStaticRequest(context, {
+      ...staticProps,
+      galleries,
+      pagination: {
+        itemsTotal: pagination.matched_records_number,
+        currentPage: 1,
+        pageSize
+      },
+      ...(typeof customProps === 'function' ? await customProps(context, staticProps) : customProps)
+    });
+  };
+}