@prezly/theme-kit-core 4.3.3 → 4.5.0

package/build/types/data-fetching/api/PrezlyApi.d.ts

@@ -1,57 +0,0 @@
-import { SortOrder } from '@prezly/sdk';
-import type { Category, Newsroom, NewsroomLanguageSettings, PrezlyClient, Stories, Story } from '@prezly/sdk';
-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;
-    /**
-     * Additional filter to apply to the story query. Note that it will be inserted into the root `$and` query operator along with default filters.
-     */
-    filterQuery?: Object;
-}
-interface GetGalleriesOptions {
-    page?: number;
-    pageSize?: number;
-}
-export declare class PrezlyApi {
-    protected readonly sdk: PrezlyClient;
-    protected readonly newsroomUuid: Newsroom['uuid'];
-    protected readonly themeUuid: string | undefined;
-    constructor(accessToken: string, newsroomUuid: Newsroom['uuid'], themeUuid?: string);
-    getStory(uuid: string): Promise<import("@prezly/sdk").ExtendedStory | null | undefined>;
-    getNewsroom(): Promise<Newsroom>;
-    getNewsroomContacts(): Promise<import("@prezly/sdk").NewsroomContact[]>;
-    getNewsroomLanguages(): Promise<NewsroomLanguageSettings[]>;
-    /**
-     * Note: this method returns ALL stories from the newsroom. It's intended to be used for sitemaps and not to display actual content.
-     */
-    getAllStories({ order, pinning, }?: Pick<GetStoriesOptions, 'order' | 'pinning'>): Promise<Story[]>;
-    getStories({ page, pageSize, order, pinning, include, localeCode, withHighlightedStory, filterQuery, }?: GetStoriesOptions): Promise<{
-        stories: Story[];
-        storiesTotal: number;
-    }>;
-    getStoriesFromCategory(category: Category, { page, pageSize, order, include, localeCode, filterQuery, }?: Omit<GetStoriesOptions, 'pinning' | 'withHighlightedStory'>): Promise<{
-        stories: Story[];
-        storiesTotal: number;
-    }>;
-    getStoryBySlug(slug: string): Promise<import("@prezly/sdk").ExtendedStory | null | undefined>;
-    getCategories(): Promise<Category[]>;
-    getCategoryBySlug(slug: string): Promise<Category | undefined>;
-    searchStories: Stories.Client['search'];
-    getGalleries({ page, pageSize }: GetGalleriesOptions): Promise<import("@prezly/sdk/dist/endpoints/NewsroomGalleries/types.js").ListResponse>;
-    getGallery(uuid: string): Promise<import("@prezly/sdk").NewsroomGallery | null | undefined>;
-    /**
-     * In order to prevent issues with theme preview, we only load the theme preset for a specified theme, and not the currently active one.
-     */
-    getThemePreset(): Promise<import("@prezly/sdk").NewsroomThemePreset | null>;
-    getNewsroomDefaultLanguage(): Promise<NewsroomLanguageSettings>;
-}
-export {};

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

@@ -1,2 +0,0 @@
-export * from './getPrezlyApi.js';
-export { PrezlyApi } from './PrezlyApi.js';

package/build/types/data-fetching/api/lib.d.ts

@@ -1,11 +0,0 @@
-export declare function toPaginationParams(params: {
-    page?: number;
-    pageSize?: number;
-    withHighlightedStory?: boolean;
-}): {
-    offset: undefined;
-    limit: undefined;
-} | {
-    offset: number;
-    limit: number;
-};

package/build/types/data-fetching/api/queries.d.ts

@@ -1,46 +0,0 @@
-import { SortOrder } from '@prezly/sdk';
-export declare function getSlugQuery(newsroomUuid: string, slug: string): {
-    $and: ({
-        lifecycle_status: {
-            $in: string[];
-        };
-        visibility?: undefined;
-    } | {
-        visibility: {
-            $in: string[];
-        };
-        lifecycle_status?: undefined;
-    } | {
-        'newsroom.uuid': {
-            $in: string[];
-        };
-        slug?: undefined;
-    } | {
-        slug: {
-            $eq: string;
-        };
-        'newsroom.uuid'?: undefined;
-    })[];
-};
-export declare function getStoriesQuery(newsroomUuid: string, categoryId?: number, localeCode?: string, filterQuery?: Object): any;
-export declare function getChronologicalSortOrder(direction: `${SortOrder.Direction}`, pinning?: boolean): SortOrder;
-export declare function getGalleriesQuery(): {
-    $and: ({
-        status: {
-            $eq: string;
-        };
-        images_number?: undefined;
-    } | {
-        images_number: {
-            $gt: number;
-        };
-        status?: undefined;
-    })[];
-};
-export declare function getContactsQuery(): {
-    $and: {
-        is_featured: {
-            $eq: boolean;
-        };
-    }[];
-};

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

@@ -1,3 +0,0 @@
-export * from './api/index.js';
-export * from './lib/index.js';
-export * from './types.js';

package/build/types/data-fetching/lib/getAlgoliaSettings.d.ts

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

package/build/types/data-fetching/lib/getEnvVariables.d.ts

@@ -1,4 +0,0 @@
-/// <reference types="node" />
-import type { IncomingMessage } from 'http';
-import type { PrezlyEnv } from '../types';
-export declare function getEnvVariables<EnvType extends PrezlyEnv = PrezlyEnv>(req?: IncomingMessage): NodeJS.ProcessEnv & EnvType;

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

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

package/build/types/data-fetching/lib/isSdkError.d.ts

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

package/build/types/data-fetching/lib/isUuid.d.ts

@@ -1 +0,0 @@
-export declare function isUuid(input: string): boolean;

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

@@ -1,13 +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/build/types/index.d.ts

@@ -1,5 +0,0 @@
-export * from './data-fetching/index.js';
-export * from './intl/index.js';
-export * from './seo/index.js';
-export * from './types.js';
-export * from './utils/index.js';

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

@@ -1,10 +0,0 @@
-import type { LangCode } from './locale';
-import { LocaleObject } from './localeObject.js';
-/**
- * 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 declare function getFallbackLocale(langCode: LangCode, availableLocales: LocaleObject[]): LocaleObject | undefined;

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

@@ -1,5 +0,0 @@
-export * from './getFallbackLocale.js';
-export * from './languages.js';
-export { default as localeConfig } from './localeConfig.cjs';
-export * from './locale.js';
-export * from './localeObject.js';

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

@@ -1,11 +0,0 @@
-import type { LocaleObject } from './localeObject';
-export declare const DEFAULT_LOCALE = "en";
-export type LangCode = string;
-export type RegionCode = string;
-export type LocaleCode = string;
-/**
- * Use this function to determine which translations file you should load from `@prezly/themes-intl-mesages` package.
- * See https://github.com/prezly/theme-nextjs-bea/blob/main/utils/lang.ts for a usage example.
- */
-export declare function getSupportedLocaleIsoCode(locale: LocaleObject): string;
-export declare function getLocaleDirection(locale: LocaleObject): 'ltr' | 'rtl';

package/build/types/intl/localeConfig.d.cts

@@ -1,2 +0,0 @@
-export = lowercaseLocalPermutations;
-declare const lowercaseLocalPermutations: string[];

package/build/types/intl/localeList.d.cts

@@ -1,2 +0,0 @@
-declare const _exports: string[];
-export = _exports;

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

@@ -1,50 +0,0 @@
-/**
- * This class is created to simplify working with locales and transforming between different locale code formats.
- * Prezly API uses underscore-codes, while most frontend application tend to use hyphen-codes or slugs.
- * Note that `fromAnyCode` constructor only accepts locales supported by Prezly backend. See `localeConfig` for reference.
- */
-export declare class LocaleObject {
-    /**
-     * Hyphen-separated locale code.
-     * Examples: `nl-BE`, `en-US`, `fr`, `fil`
-     */
-    private localeCode;
-    /**
-     * Whether the locale is region independent (without region/culture part).
-     * I.E. `en` is region independent, while `en-US` is not.
-     */
-    isRegionIndependent: boolean;
-    private constructor();
-    /**
-     * @param localeCode Locale code in any of the formats below.
-     * Examples:
-     * - Hyphen-codes: `nl-BE`, `en-US`, `fr`, `fil`
-     * - Underscore-codes: `nl_BE`, `en_US`, `fr`, `fil`
-     * - Slugs: `nl-be`, `en-us`, `fr`, `fil`
-     */
-    static fromAnyCode(localeCode: string): LocaleObject;
-    /**
-     * @returns Code formatted into hyphen format: `nl-BE`, `en-US`, `fr`, `fil`
-     */
-    toHyphenCode(): string;
-    /**
-     * @returns Code formatted into underscore format, as expected by Prezly API: `nl_BE`, `en_US`, `fr`, `fil`
-     */
-    toUnderscoreCode(): string;
-    /**
-     * @returns Code formatted to a URL-friendly lowercase slug format: `nl-be`, `en-us`, `fr`, `fil`
-     */
-    toUrlSlug(): string;
-    /**
-     * @returns Only the language part of the code without culture/region part: `nl`, `en`, `fr`
-     */
-    toNeutralLanguageCode(): string;
-    /**
-     * @returns Only the culture/regtion part without the language part: `be`, `us`, `fr`
-     */
-    toRegionCode(): string;
-    /**
-     * Check if two LocaleObject instances are representing the same locale code.
-     */
-    isEqual(anotherLocale: LocaleObject): boolean;
-}

package/build/types/seo/getAlternateLanguageLinks.d.ts

@@ -1,4 +0,0 @@
-import type { NewsroomLanguageSettings } from '@prezly/sdk';
-import type { LocaleObject } from '../intl/index.js';
-import type { AlternateLanguageLink } from './types';
-export declare function getAlternateLanguageLinks(availableLanguages: NewsroomLanguageSettings[], generateTranslationUrl: (locale: LocaleObject) => string | undefined): AlternateLanguageLink[];

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

@@ -1,2 +0,0 @@
-export * from './getAlternateLanguageLinks.js';
-export * from './types.js';

package/build/types/seo/types.d.ts

@@ -1,4 +0,0 @@
-export type AlternateLanguageLink = {
-    href: string;
-    hrefLang: string;
-};

package/build/types/seo/utils/createAlternateLanguageLink.d.ts

@@ -1,5 +0,0 @@
-import type { LocaleObject } from '../../intl';
-export declare function createAlternateLanguageLink(locale: LocaleObject, generateTranslationUrl: (locale: LocaleObject) => string | undefined): {
-    hrefLang: string;
-    href: string;
-} | undefined;

package/build/types/seo/utils/index.d.ts

@@ -1,2 +0,0 @@
-export { bindLanguagesWithLocales } from './bindLanguagesWithLocales.js';
-export { createAlternateLanguageLink } from './createAlternateLanguageLink.js';

package/build/types/types.d.ts

@@ -1,29 +0,0 @@
-import type { CultureRef, Story } from '@prezly/sdk';
-/**
- * Categories in Algolia index are stored in a simplified format, with `slug` and `name` properties already saved in the correct locale for the story search result.
- */
-export interface AlgoliaCategoryRef {
-    id: number;
-    name: string;
-    slug: string;
-}
-/**
- * Stories in Algolia index are stored in a simplified format, with only minimal subset of fields.
- */
-export type AlgoliaStory = Pick<Story, 'uuid' | 'slug' | 'title' | 'subtitle'> & Pick<Story.ExtraFields, 'thumbnail_image'> & {
-    content_text: string;
-    updated_at: number;
-    published_at: number;
-    culture: Pick<CultureRef, 'code' | 'name' | 'native_name' | 'language_code'>;
-    categories: AlgoliaCategoryRef[];
-};
-export interface SdkError extends Error {
-    status: number;
-    statusText: string;
-    payload: {
-        errors: {
-            reason: string;
-        };
-        message: string;
-    };
-}

package/build/types/utils/boilerplate.d.ts

@@ -1,4 +0,0 @@
-import type { NewsroomCompanyInformation } from '@prezly/sdk';
-export declare function hasAnySocialMedia(companyInformation: NewsroomCompanyInformation): boolean;
-export declare function hasAnyAboutInformation(companyInformation: NewsroomCompanyInformation): boolean;
-export declare function hasAnyContactInformation(companyInformation: NewsroomCompanyInformation): boolean;

package/build/types/utils/constants.d.ts

@@ -1,3 +0,0 @@
-export declare const ASSETS_URL = "https://cdn.uc.assets.prezly.com";
-export declare const DEFAULT_PAGE_SIZE = 12;
-export declare const DEFAULT_GALLERY_PAGE_SIZE = 6;

package/build/types/utils/getAssetsUrl.d.ts

@@ -1,5 +0,0 @@
-/**
- * @param uuid UUID of the assets hosted on Uploadcare
- * @returns Full asset URL that can be used as a source for <img>, <video> and <a> tags.
- */
-export declare function getAssetsUrl(uuid: string): string;

package/build/types/utils/getDataRequestLink.d.ts

@@ -1,3 +0,0 @@
-import type { Newsroom } from '@prezly/sdk';
-import type { LocaleObject } from '../intl';
-export declare function getDataRequestLink(newsroom: Newsroom, currentLocale: LocaleObject): string;

package/build/types/utils/getLocalizedCategoryData.d.ts

@@ -1,10 +0,0 @@
-import type { Category } from '@prezly/sdk';
-import type { LocaleObject } from '../intl/index.js';
-import type { AlgoliaCategoryRef } from '../types';
-export declare function getLocalizedCategoryData(category: Category | AlgoliaCategoryRef, locale: LocaleObject): {
-    description: string | null;
-    name: string;
-    slug: string | null;
-};
-export declare function getCategoryUrl(category: Category | AlgoliaCategoryRef, locale: LocaleObject): string;
-export declare function getCategoryHasTranslation(category: Category, locale: LocaleObject): boolean;

package/build/types/utils/getNewsroomLogoUrl.d.ts

@@ -1,3 +0,0 @@
-import type { Newsroom } from '@prezly/sdk';
-export declare function getNewsroomLogoUrl(newsroom: Newsroom): string;
-export declare function getNewsroomFaviconUrl(newsroom: Newsroom, previewSize?: number): string;

package/build/types/utils/getPrivacyPortalUrl.d.ts

@@ -1,8 +0,0 @@
-import type { Newsroom } from '@prezly/sdk';
-import type { LocaleObject } from '../intl/index.js';
-type PrivacyPortalUrlOptions = {
-    email?: string;
-    action?: 'data-request' | 'subscribe' | 'unsubscribe';
-};
-export declare function getPrivacyPortalUrl(newsroom: Newsroom, locale: LocaleObject, options?: PrivacyPortalUrlOptions): string;
-export {};

package/build/types/utils/getStoryPublicationDate.d.ts

@@ -1,3 +0,0 @@
-import type { Story } from '@prezly/sdk';
-import type { AlgoliaStory } from '../types';
-export declare function getStoryPublicationDate(story: Story | AlgoliaStory): Date | null;

package/build/types/utils/getUploadcareGroupUrl.d.ts

@@ -1,8 +0,0 @@
-/**
- * This method constructs a URL to download all images in the Gallery as a single archive.
- *
- * @param uuid Gallery UUID
- * @param title Filename for the saved archive. Usually it is the Gallery title.
- * @returns URL to an archive containing all of the images in the Gallery.
- */
-export declare function getUploadcareGroupUrl(uuid: string, title: string): string;

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

@@ -1,10 +0,0 @@
-export * from './boilerplate.js';
-export * from './constants.js';
-export * from './getAssetsUrl.js';
-export * from './getDataRequestLink.js';
-export * from './getLocalizedCategoryData.js';
-export * from './getNewsroomLogoUrl.js';
-export * from './getPrivacyPortalUrl.js';
-export * from './getStoryPublicationDate.js';
-export * from './getUploadcareGroupUrl.js';
-export * from './isEmbargoStory.js';

package/build/types/utils/isEmbargoStory.d.ts

@@ -1,6 +0,0 @@
-import type { Story } from '@prezly/sdk';
-export type EmbargoStory = Omit<Story, 'is_embargo' | 'published_at'> & {
-    is_embargo: true;
-    published_at: string;
-};
-export declare function isEmbargoStory(story: Story): story is EmbargoStory;