@prezly/theme-kit-nextjs 4.3.5-alpha.0 → 4.5.0

package/build/types/adapter-nextjs/page-props/sitemap/SitemapBuilder.d.ts

@@ -1,11 +0,0 @@
-import type { SitemapUrl } from './types';
-export declare class SitemapBuilder {
-    private baseUrl;
-    private urls;
-    constructor(baseUrl: string);
-    addUrl(location: string): void;
-    private static guessFrequency;
-    private static guessPriority;
-    static serializeLocation(url: SitemapUrl): string;
-    serialize(): string;
-}

package/build/types/adapter-nextjs/page-props/sitemap/createPaths.d.ts

@@ -1,2 +0,0 @@
-import type { Category, Story } from '@prezly/sdk';
-export declare function createPaths(stories: Story[], categories: Category[]): string[];

package/build/types/adapter-nextjs/page-props/sitemap/getServerSideProps.d.ts

@@ -1,7 +0,0 @@
-import type { NextPageContext } from 'next';
-export declare function getSitemapServerSideProps(options?: {
-    additionalPaths?: string[];
-    pinning?: boolean;
-}): (ctx: NextPageContext) => Promise<{
-    props: {};
-}>;

package/build/types/adapter-nextjs/page-props/sitemap/index.d.ts

@@ -1,4 +0,0 @@
-export { getSitemapServerSideProps } from './getServerSideProps.js';
-export { SitemapBuilder } from './SitemapBuilder.js';
-export { createPaths } from './createPaths.js';
-export * from './types.js';

package/build/types/adapter-nextjs/page-props/sitemap/types.d.ts

@@ -1,5 +0,0 @@
-export type SitemapUrl = {
-    location: string;
-    changeFrequency?: string;
-    priority?: string;
-};

package/build/types/adapter-nextjs/page-props/story.d.ts

@@ -1,14 +0,0 @@
-import type { GetServerSidePropsContext, GetServerSidePropsResult, GetStaticPropsContext, GetStaticPropsResult } from 'next';
-import type { PropsFunction } from './lib/types';
-export declare function getStoryPageServerSideProps<CustomProps extends Record<string, any>>(customProps: CustomProps | PropsFunction<CustomProps>): (context: GetServerSidePropsContext) => Promise<GetServerSidePropsResult<CustomProps>>;
-export declare function getStoryPageStaticProps<CustomProps extends Record<string, any>>(customProps: CustomProps | PropsFunction<CustomProps, GetStaticPropsContext>): (context: GetStaticPropsContext) => Promise<GetStaticPropsResult<CustomProps>>;
-export declare function getStoryPageStaticPaths(options?: {
-    pinning?: boolean;
-}): Promise<{
-    paths: {
-        params: {
-            slug: string;
-        };
-    }[];
-    fallback: string;
-}>;

package/build/types/adapter-nextjs/page-props/storyPreview.d.ts

@@ -1,3 +0,0 @@
-import type { GetServerSidePropsContext, GetServerSidePropsResult } from 'next';
-import type { PropsFunction } from './lib/types';
-export declare function getStoryPreviewPageServerSideProps<CustomProps extends Record<string, any>>(customProps: CustomProps | PropsFunction<CustomProps>): (context: GetServerSidePropsContext) => Promise<GetServerSidePropsResult<CustomProps>>;

package/build/types/adapter-nextjs/processRequest.d.ts

@@ -1,12 +0,0 @@
-import type { GetServerSidePropsContext, GetServerSidePropsResult } from 'next';
-import type { PageProps, ServerSidePageProps } from '../types';
-/**
- * This function combines the props returned from `getNewsroomServerSideProps` and your optional custom props for the page.
- * It also handles locale redirects, if `canonicalUrl` parameter is provided.
- * See README for usage examples.
- *
- * @param context Next.js context passed to the `getServerSideProps` method of the page
- * @param props Object containing the return of `getNewsroomServerSideProps` and your optional custom props.
- * @param canonicalUrl Optional: a canonical URL for the current page without locale part. If provided, locale redirects will be handled by the function.
- */
-export declare function processRequest<Props>(context: GetServerSidePropsContext, props: Props & PageProps & ServerSidePageProps, canonicalUrl?: string): GetServerSidePropsResult<Props>;

package/build/types/adapter-nextjs/processStaticRequest.d.ts

@@ -1,11 +0,0 @@
-import type { GetStaticPropsContext, GetStaticPropsResult } from 'next';
-import type { PageProps, ServerSidePageProps } from '../types';
-/**
- * This function combines the props returned from `getNewsroomStaticProps` and your optional custom props for the page.
- * See README for usage examples.
- *
- * @param context Next.js context passed to the `getStaticProps` method of the page
- * @param props Object containing the return of `getNewsroomServerSideProps` and your optional custom props.
- * @param revalidateTimeout Optional: timeout in seconds to use with Next ISR.
- */
-export declare function processStaticRequest<Props>(context: GetStaticPropsContext, props: Props & PageProps & ServerSidePageProps, revalidateTimeout?: number): GetStaticPropsResult<Props>;

package/build/types/client.d.ts

@@ -1,7 +0,0 @@
-/**
- * This is a subset export created for Next 13 /app directory, which doesn't support tree-shaking properly.
- * See https://github.com/vercel/next.js/issues/12557
- */
-export * from './components-nextjs/index.js';
-export * from './infinite-loading/index.js';
-export * from './newsroom-context/index.js';

package/build/types/components-nextjs/PageSeo/PageSeo.d.ts

@@ -1,12 +0,0 @@
-/// <reference types="react" />
-import type { NextSeoProps } from 'next-seo';
-type Props = NextSeoProps & {
-    imageUrl?: string;
-};
-/**
- * This component provides base page attributes for every Newsroom page.
- * It depends on information from NewsroomContext, so the component should be placed inside the `NewsroomContextProvider`.
- * You can pass additional props expected by NextSeo component to override any info that is provided by the NewsroomContext.
- */
-export declare function PageSeo({ title, description, imageUrl, canonical, openGraph, twitter, ...nextSeoProps }: Props): JSX.Element;
-export {};

package/build/types/components-nextjs/PageSeo/index.d.ts

@@ -1 +0,0 @@
-export { PageSeo } from './PageSeo.js';

package/build/types/components-nextjs/PageSeo/lib/getAbsoluteUrl.d.ts

@@ -1 +0,0 @@
-export declare function getAbsoluteUrl(path: string, origin: string, localeCode?: string | false): string;

package/build/types/components-nextjs/PageSeo/lib/index.d.ts

@@ -1 +0,0 @@
-export { getAbsoluteUrl } from './getAbsoluteUrl.js';

package/build/types/components-nextjs/StorySeo/StorySeo.d.ts

@@ -1,12 +0,0 @@
-/// <reference types="react" />
-import type { ExtendedStory } from '@prezly/sdk';
-type Props = {
-    story: ExtendedStory;
-    noindex?: boolean;
-};
-/**
- * This components provides additional page attributes for the Story page.
- * It works in conjunction with `PageSeo` component, overidding some of its attributes.
- */
-export declare function StorySeo({ story, noindex }: Props): JSX.Element;
-export {};

package/build/types/components-nextjs/StorySeo/index.d.ts

@@ -1 +0,0 @@
-export { StorySeo } from './StorySeo.js';

package/build/types/components-nextjs/document.d.ts

@@ -1,6 +0,0 @@
-/// <reference types="react" />
-import Document from 'next/document';
-export declare class PrezlyThemeDocument extends Document {
-    getLocaleCode(): string;
-    render(): JSX.Element;
-}

package/build/types/components-nextjs/index.d.ts

@@ -1,3 +0,0 @@
-export { PageSeo } from './PageSeo/index.js';
-export { StorySeo } from './StorySeo/index.js';
-export { PrezlyThemeDocument } from './document.js';

package/build/types/data-fetching/NextPrezlyApi.d.ts

@@ -1,8 +0,0 @@
-/// <reference types="node" />
-import type { Story } from '@prezly/sdk';
-import { PrezlyApi } from '@prezly/theme-kit-core';
-import type { IncomingMessage } from 'http';
-import type { PageProps, ServerSidePageProps } from '../types';
-export declare class NextPrezlyApi extends PrezlyApi {
-    getNewsroomServerSideProps(request?: IncomingMessage, nextLocaleIsoCode?: string, story?: Story): Promise<PageProps & ServerSidePageProps>;
-}

package/build/types/data-fetching/getNextPrezlyApi.d.ts

@@ -1,4 +0,0 @@
-/// <reference types="node" />
-import type { IncomingMessage } from 'http';
-import { NextPrezlyApi } from './NextPrezlyApi.js';
-export declare function getNextPrezlyApi(req?: IncomingMessage): NextPrezlyApi;

package/build/types/data-fetching/index.d.ts

@@ -1 +0,0 @@
-export { getNextPrezlyApi } from './getNextPrezlyApi.js';

package/build/types/i18nConfig.d.cts

@@ -1,3 +0,0 @@
-export = i18nConfig;
-/** @type {import('next').NextConfig['i18n']} */
-declare const i18nConfig: import('next').NextConfig['i18n'];

package/build/types/index.d.ts

@@ -1,8 +0,0 @@
-export * from './adapter-nextjs/index.js';
-export * from './components-nextjs/index.js';
-export * from './data-fetching/index.js';
-export * from './infinite-loading/index.js';
-export * from './intl/index.js';
-export * from './newsroom-context/index.js';
-export * from './sentry/index.js';
-export * from './types.js';

package/build/types/infinite-loading/index.d.ts

@@ -1,4 +0,0 @@
-export { useInfiniteLoading } from './useInfiniteLoading.js';
-export { useInfiniteStoriesLoading } from './useInfiniteStoriesLoading.js';
-export { useInfiniteGalleriesLoading } from './useInfiniteGalleriesLoading.js';
-export * from './types.js';

package/build/types/infinite-loading/types.d.ts

@@ -1,9 +0,0 @@
-export interface PaginationProps {
-    itemsTotal: number;
-    currentPage: number;
-    pageSize: number;
-    /**
-     * When set to `true`, the calculated offset will be increased by one to account for the highlighted story
-     */
-    withHighlightedStory?: boolean;
-}

package/build/types/infinite-loading/useInfiniteGalleriesLoading.d.ts

@@ -1,13 +0,0 @@
-import type { NewsroomGallery } from '@prezly/sdk';
-import type { PaginationProps } from './types';
-/**
- * NOTE: This hook depends on the presence of a Next API route (/api/fetch-galleries)!
- * The handler for this route is exported from `apiHandlers/fetchGalleries.ts` file.
- * See https://github.com/prezly/theme-nextjs-bea/blob/d381e9878187ca98815d240d3ffdf10a75993c14/pages/media/index.tsx#L23 for usage example
- */
-export declare function useInfiniteGalleriesLoading(initialGalleries: NewsroomGallery[], pagination: PaginationProps): {
-    canLoadMore: boolean;
-    galleries: NewsroomGallery[];
-    isLoading: boolean;
-    loadMoreGalleries: () => void;
-};

package/build/types/infinite-loading/useInfiniteLoading.d.ts

@@ -1,16 +0,0 @@
-import type { PaginationProps } from './types';
-interface Parameters<T> {
-    fetchingFn: (page: number, pageSize: number) => Promise<T[]>;
-    initialData: T[];
-    pagination: PaginationProps;
-}
-interface State<T> {
-    canLoadMore: boolean;
-    currentPage: number;
-    data: T[];
-    isLoading: boolean;
-    loadMore: () => void;
-    resetData: () => void;
-}
-export declare function useInfiniteLoading<T>({ fetchingFn, initialData, pagination, }: Parameters<T>): State<T>;
-export {};

package/build/types/infinite-loading/useInfiniteStoriesLoading.d.ts

@@ -1,13 +0,0 @@
-import type { Category, Story } from '@prezly/sdk';
-import type { PaginationProps } from './types';
-/**
- * NOTE: This hook depends on the presence of a Next API route (/api/fetch-stories)!
- * The handler for this route is exported from `apiHandlers/fetchStories.ts` file.
- * See https://github.com/prezly/theme-nextjs-bea/blob/d381e9878187ca98815d240d3ffdf10a75993c14/pages/index.tsx#L24 for usage example
- */
-export declare function useInfiniteStoriesLoading<T extends Story = Story>(initialStories: T[], pagination: PaginationProps, category?: Category, include?: (keyof Story.ExtraFields)[], pinning?: boolean, filterQuery?: Object): {
-    canLoadMore: boolean;
-    isLoading: boolean;
-    loadMoreStories: () => void;
-    stories: T[];
-};

package/build/types/intl/index.d.ts

@@ -1,2 +0,0 @@
-export * from './languages.js';
-export * from './locale.js';

package/build/types/intl/languages.d.ts

@@ -1,6 +0,0 @@
-import type { NewsroomLanguageSettings } from '@prezly/sdk';
-/**
- * Retrieve a culture with fallback to legacy codes support.
- * Pulled from https://github.com/prezly/prezly/blob/de9900d9890a33502780494aa3fb85c9a732b3c3/lib/model/CulturePeer.php#L91-L114
- */
-export declare function getLanguageFromNextLocaleIsoCode(languages: NewsroomLanguageSettings[], nextLocaleIsoCode?: string): NewsroomLanguageSettings | undefined;

package/build/types/intl/locale.d.ts

@@ -1,5 +0,0 @@
-/// <reference types="node" />
-import type { Redirect } from 'next';
-import type { ParsedUrlQuery } from 'querystring';
-export declare const DUMMY_DEFAULT_LOCALE = "qps-ploc";
-export declare function getRedirectToCanonicalLocale(shortestLocaleCode: string | false, nextLocaleIsoCode: string | undefined, redirectPath: string, query?: ParsedUrlQuery): Redirect | undefined;

package/build/types/newsroom-context/context.d.ts

@@ -1,62 +0,0 @@
-import type { Category, ExtendedStory, Newsroom, NewsroomCompanyInformation, NewsroomContact, NewsroomLanguageSettings, NewsroomThemePreset, Notification } from '@prezly/sdk';
-import type { AlgoliaSettings } from '@prezly/theme-kit-core';
-import { LocaleObject } from '@prezly/theme-kit-core';
-import type { PropsWithChildren } from 'react';
-export interface NewsroomContextType {
-    /**
-     * Basic newsroom information: newsroom logos, settings, etc.
-     */
-    newsroom: Newsroom;
-    /**
-     * Contact information of the newsroom in the default language, usually displayed in the "About" section
-     */
-    companyInformation: NewsroomCompanyInformation;
-    /**
-     * List of all categories enabled on the newsroom
-     */
-    categories: Category[];
-    /**
-     * Optional: Contacts set up to be displayed on the newsroom home page.
-     * Will only be loaded if `loadHomepageContacts` option of `getNewsroomServerSideProps` is set to `true`.
-     */
-    contacts?: NewsroomContact[];
-    /**
-     * Optional: Refers to a currently selected category when navigated to `/category/[slug]` page.
-     */
-    currentCategory?: Category;
-    /**
-     * Optional: Refers to a currently selected story when navigated to `/[slug]` page.
-     */
-    currentStory?: ExtendedStory;
-    /**
-     * List of currently enabled newsroom languages, as well as company information translated for each language
-     */
-    languages: NewsroomLanguageSettings[];
-    /**
-     * Currently chosen locale
-     */
-    locale: LocaleObject;
-    /**
-     * Newsroom user-facing notifications (usually displayed as top-edge banners)
-     */
-    notifications: Notification[];
-    /**
-     * Theme settings as set in the Prezly app.
-     * You need to provide `PREZLY_THEME_UUID` in environment variables in order for the preset to be loaded.
-     * Only applicable to themes hosted on the Prezly infrastructure.
-     */
-    themePreset: NewsroomThemePreset | null;
-    /**
-     * Environment variables required for Algolia search to work.
-     */
-    algoliaSettings: AlgoliaSettings;
-}
-export interface NewsroomContextProps extends Omit<NewsroomContextType, 'locale'> {
-    localeCode: string;
-}
-export declare const NewsroomContext: import("react").Context<NewsroomContextType | undefined>;
-/**
- * This context provides common Newsroom information retrieved by `getNewsroomServerSideProps` helper.
- * Please refer to the `NewsroomContextType` definition for more info on what's exposed from the context.
- */
-export declare function NewsroomContextProvider({ categories, contacts, newsroom, currentCategory, currentStory, companyInformation, languages, localeCode, notifications, themePreset, algoliaSettings, children, }: PropsWithChildren<NewsroomContextProps>): JSX.Element;

package/build/types/newsroom-context/hooks/index.d.ts

@@ -1,11 +0,0 @@
-export * from './useAlgoliaSettings.js';
-export * from './useCategories.js';
-export * from './useCompanyInformation.js';
-export * from './useCurrentCategory.js';
-export * from './useCurrentLocale.js';
-export * from './useCurrentStory.js';
-export * from './useGetLinkLocaleSlug.js';
-export * from './useGetTranslationUrl.js';
-export * from './useLanguages.js';
-export * from './useNewsroom.js';
-export * from './useNewsroomContext.js';

package/build/types/newsroom-context/hooks/useAlgoliaSettings.d.ts

@@ -1 +0,0 @@
-export declare function useAlgoliaSettings(): import("@prezly/theme-kit-core").AlgoliaSettings;

package/build/types/newsroom-context/hooks/useCategories.d.ts

@@ -1 +0,0 @@
-export declare function useCategories(): import("@prezly/sdk").Category[];

package/build/types/newsroom-context/hooks/useCompanyInformation.d.ts

@@ -1 +0,0 @@
-export declare function useCompanyInformation(): import("@prezly/sdk").NewsroomCompanyInformation;

package/build/types/newsroom-context/hooks/useCurrentCategory.d.ts

@@ -1 +0,0 @@
-export declare function useCurrentCategory(): import("@prezly/sdk").Category | undefined;

package/build/types/newsroom-context/hooks/useCurrentLocale.d.ts

@@ -1 +0,0 @@
-export declare function useCurrentLocale(): import("@prezly/theme-kit-core").LocaleObject;

package/build/types/newsroom-context/hooks/useCurrentStory.d.ts

@@ -1 +0,0 @@
-export declare function useCurrentStory(): import("@prezly/sdk").ExtendedStory | undefined;

package/build/types/newsroom-context/hooks/useGetLinkLocaleSlug.d.ts

@@ -1,2 +0,0 @@
-import { LocaleObject } from '@prezly/theme-kit-core';
-export declare function useGetLinkLocaleSlug(): (locale?: LocaleObject) => string | false;

package/build/types/newsroom-context/hooks/useGetTranslationUrl.d.ts

@@ -1,6 +0,0 @@
-import type { LocaleObject } from '@prezly/theme-kit-core';
-/**
- * This hook returns a function that is meant to be used in language pickers and alternate locales list for the pages.
- * `noFallback` parameter is useful for alternate language links in the `head` section of the document (so that there are no unwanted links to the homepage).
- */
-export declare function useGetTranslationUrl(): (locale: LocaleObject, noFallback?: boolean) => string;

package/build/types/newsroom-context/hooks/useLanguages.d.ts

@@ -1 +0,0 @@
-export declare function useLanguages(): import("@prezly/sdk").NewsroomLanguageSettings[];

package/build/types/newsroom-context/hooks/useNewsroom.d.ts

@@ -1 +0,0 @@
-export declare function useNewsroom(): import("@prezly/sdk").Newsroom;

package/build/types/newsroom-context/hooks/useNewsroomContext.d.ts

@@ -1,2 +0,0 @@
-import type { NewsroomContextType } from '../context';
-export declare function useNewsroomContext(): NewsroomContextType;

package/build/types/newsroom-context/index.d.ts

@@ -1,2 +0,0 @@
-export { NewsroomContext, NewsroomContextProvider, type NewsroomContextProps } from './context.js';
-export * from './hooks/index.js';

package/build/types/sentry/client.d.ts

@@ -1,2 +0,0 @@
-import type { init } from '@sentry/nextjs';
-export declare function getSentryClientOptions(dsn: string, themeName: string | null): Parameters<typeof init>[0];

package/build/types/sentry/common.d.ts

@@ -1,2 +0,0 @@
-import type { init } from '@sentry/nextjs';
-export declare function getCommonClientOptions(dsn: string, themeName: string | null): Parameters<typeof init>[0];

package/build/types/sentry/index.d.ts

@@ -1,2 +0,0 @@
-export { getSentryClientOptions } from './client.js';
-export { getSentryServerOptions } from './server.js';

package/build/types/sentry/server.d.ts

@@ -1,2 +0,0 @@
-import type { init } from '@sentry/nextjs';
-export declare function getSentryServerOptions(dsn: string, themeName: string | null): Parameters<typeof init>[0];

package/build/types/server.d.ts

@@ -1,7 +0,0 @@
-/**
- * This is a subset export created for Next 13 /app directory, which doesn't support tree-shaking properly.
- * See https://github.com/vercel/next.js/issues/12557
- *
- */
-export * from './adapter-nextjs/index.js';
-export * from './data-fetching/index.js';

package/build/types/types.d.ts

@@ -1,14 +0,0 @@
-import type { NewsroomContextProps } from './newsroom-context/index.js';
-export interface ServerSidePageProps {
-    /**
-     * Indicates whether the locale requested by the Next application was correctly resolved to an active newsroom locale.
-     * This is used by `processRequest` method to redirect to the default locale if the property is `false`.
-     */
-    localeResolved: boolean;
-}
-/**
- * These are the props returned by the `processRequest` method that are meant to be passed to your `_app` to be injected into the `NewsroomContextProvider`.
- */
-export interface PageProps {
-    newsroomContextProps: NewsroomContextProps;
-}