@city-of-helsinki/react-helsinki-headless-cms 3.0.0-rc.1 → 3.0.0

package/dist/src/core/language/findLanguage.d.ts

@@ -0,0 +1,10 @@
+import type { Language } from '../../common/headlessService/types';
+/**
+ * Find language from language list by language code.
+ * @param {Language[]} languages - List of languages
+ * @param {string} languageCode - Language code
+ * @returns {Language | undefined} Language from given language list with the given
+ *                                 language code or undefined if not found
+ */
+declare function findLanguage(languages: Language[], languageCode: string): Language | undefined;
+export default findLanguage;

package/dist/src/core/language/index.d.ts

@@ -0,0 +1,6 @@
+export * from './constants';
+export { default as findLanguage } from './findLanguage';
+export { default as languageSorter } from './languageSorter';
+export { default as toPrimaryLanguageOption } from './toPrimaryLanguageOption';
+export * from './typeGuards';
+export * from './types';

package/dist/src/core/language/languageSorter.d.ts

@@ -0,0 +1,4 @@
+import type { NonEmptyLanguage } from './types';
+/** Sorting function for NonEmptyLanguage elements. */
+declare const languageSorter: (left: NonEmptyLanguage, right: NonEmptyLanguage) => number;
+export default languageSorter;

package/dist/src/core/language/toPrimaryLanguageOption.d.ts

@@ -0,0 +1,5 @@
+import type { LanguageOption } from 'hds-react';
+import type { NonEmptyLanguage } from './types';
+/** Map a NonEmptyLanguage to a primary LanguageOption. */
+declare const toPrimaryLanguageOption: (language: NonEmptyLanguage) => LanguageOption;
+export default toPrimaryLanguageOption;

package/dist/src/core/language/typeGuards.d.ts

@@ -0,0 +1,3 @@
+import type { NonEmptyLanguage } from './types';
+import type { Language } from '../../common/headlessService/types';
+export declare const isNonEmptyLanguage: (language?: Language | null) => language is NonEmptyLanguage;

package/dist/src/core/language/types.d.ts

@@ -0,0 +1,5 @@
+import type { Language } from '../../common/headlessService/types';
+export type NonEmptyLanguage = Language & {
+    code: NonNullable<Language['code']>;
+    name: NonNullable<Language['name']>;
+};

package/dist/src/core/link/Link.d.ts

@@ -0,0 +1,44 @@
+import React from 'react';
+export type LinkProps = Omit<React.ComponentPropsWithoutRef<'a'>, 'target' | 'href' | 'onPointerEnterCapture' | 'onPointerLeaveCapture'> & {
+    /**
+     * Link href.
+     */
+    href?: string;
+    /**
+     * Link left icon component.
+     */
+    iconLeft?: React.ReactNode;
+    /**
+     * Link right icon component.
+     */
+    iconRight?: React.ReactNode;
+    /**
+     * Boolean indicating whether the external icon is shown.
+     */
+    showExternalIcon?: boolean;
+    /**
+     * Boolean indicating whether the link should be opened in a new tab.
+     */
+    openInNewTab?: boolean;
+    /**
+     * Link text font size.
+     */
+    size?: 'S' | 'M' | 'L';
+    /**
+     * Link variant.
+     */
+    variant?: 'default' | 'arrowRight';
+    /**
+     * Additional children to render inside the Link.
+     */
+    children?: React.ReactNode;
+    /**
+     * Additinal classname applied to the Link.
+     */
+    className?: string;
+    /**
+     * Boolean indicating whether the icons should be displayed with inline styling.
+     */
+    inlineIcons?: boolean;
+};
+export declare function Link({ href, children, showExternalIcon: forceShowExternalIcon, openInNewTab: forceOpenInNewTab, className, size, iconRight, inlineIcons, ...delegatedProps }: LinkProps): React.JSX.Element;

package/dist/src/core/link/Link.stories.d.ts

@@ -0,0 +1,33 @@
+import React from 'react';
+import { Link } from './Link';
+import { SecondaryLink } from './SecondaryLink';
+declare const _default: {
+    title: string;
+    component: typeof Link;
+    subcomponents: {
+        SecondaryLink: typeof SecondaryLink;
+    };
+    argTypes: {
+        iconRight: {
+            control: false;
+        };
+        iconLeft: {
+            control: false;
+        };
+    };
+};
+export default _default;
+export declare const LinkAllTypes: {
+    render: import("storybook/internal/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, Omit<Omit<React.DetailedHTMLProps<React.AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, "ref">, "target" | "href" | "onPointerEnterCapture" | "onPointerLeaveCapture"> & {
+        href?: string;
+        iconLeft?: React.ReactNode;
+        iconRight?: React.ReactNode;
+        showExternalIcon?: boolean;
+        openInNewTab?: boolean;
+        size?: "S" | "M" | "L";
+        variant?: "default" | "arrowRight";
+        children?: React.ReactNode;
+        className?: string;
+        inlineIcons?: boolean;
+    }>;
+};

package/dist/src/core/link/LinkBase.d.ts

@@ -0,0 +1,106 @@
+import React from 'react';
+import type { ReactNode } from 'react';
+export type LinkProps = Omit<React.ComponentPropsWithoutRef<'a'>, 'target' | 'href' | 'onPointerEnterCapture' | 'onPointerLeaveCapture'> & {
+    /**
+     * Link content
+     */
+    children: ReactNode;
+    /**
+     * Boolean indicating whether visited styles of the link are applied
+     */
+    disableVisitedStyles?: boolean;
+    /**
+     * Boolean indicating whether the link will lead user to external domain.
+     */
+    external?: boolean;
+    /**
+     * Boolean indicating whether the link will lead user to external domain.
+     */
+    showExternalIcon?: boolean;
+    /**
+     * Hypertext Reference of the link.
+     */
+    href: string;
+    /**
+     * Element placed on the left side of the link text
+     */
+    iconLeft?: React.ReactNode;
+    /**
+     * Element placed on the right side of the link text
+     */
+    iconRight?: React.ReactNode;
+    /**
+     * Boolean indicating whether the link will open in new tab or not.
+     */
+    openInNewTab?: boolean;
+    /**
+     * Aria label for opening link in a new tab
+     */
+    openInNewTabAriaLabel?: string;
+    /**
+     * Aria label for opening link in an external domain
+     */
+    openInExternalDomainAriaLabel?: string;
+    /**
+     * Size of the link
+     */
+    size?: 'S' | 'M' | 'L';
+    /**
+     * Additional styles
+     */
+    style?: React.CSSProperties;
+    inlineIcons?: boolean;
+};
+export declare const getTextFromReactChildren: (children: ReactNode) => string;
+declare const _default: React.ForwardRefExoticComponent<Omit<Omit<React.DetailedHTMLProps<React.AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, "ref">, "href" | "target" | "onPointerEnterCapture" | "onPointerLeaveCapture"> & {
+    /**
+     * Link content
+     */
+    children: ReactNode;
+    /**
+     * Boolean indicating whether visited styles of the link are applied
+     */
+    disableVisitedStyles?: boolean;
+    /**
+     * Boolean indicating whether the link will lead user to external domain.
+     */
+    external?: boolean;
+    /**
+     * Boolean indicating whether the link will lead user to external domain.
+     */
+    showExternalIcon?: boolean;
+    /**
+     * Hypertext Reference of the link.
+     */
+    href: string;
+    /**
+     * Element placed on the left side of the link text
+     */
+    iconLeft?: React.ReactNode;
+    /**
+     * Element placed on the right side of the link text
+     */
+    iconRight?: React.ReactNode;
+    /**
+     * Boolean indicating whether the link will open in new tab or not.
+     */
+    openInNewTab?: boolean;
+    /**
+     * Aria label for opening link in a new tab
+     */
+    openInNewTabAriaLabel?: string;
+    /**
+     * Aria label for opening link in an external domain
+     */
+    openInExternalDomainAriaLabel?: string;
+    /**
+     * Size of the link
+     */
+    size?: "S" | "M" | "L";
+    /**
+     * Additional styles
+     */
+    style?: React.CSSProperties;
+    inlineIcons?: boolean;
+} & React.RefAttributes<HTMLAnchorElement>>;
+export default _default;

package/dist/src/core/link/SecondaryLink.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+import type { LinkProps } from './Link';
+export declare function SecondaryLink({ className, children, variant, ...delegatedProps }: LinkProps): React.JSX.Element;

package/dist/src/core/link/__tests__/Link.test.d.ts

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

package/dist/src/core/linkBox/Link.stories.d.ts

@@ -0,0 +1,23 @@
+import React from 'react';
+import { LinkBox } from './LinkBox';
+declare const _default: {
+    title: string;
+    component: typeof LinkBox;
+    argTypes: {
+        iconRight: {
+            control: false;
+        };
+        iconLeft: {
+            control: false;
+        };
+    };
+};
+export default _default;
+export declare const LinkboxDefault: {
+    render: import("storybook/internal/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, Omit<Omit<React.DetailedHTMLProps<React.AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, "ref">, "target"> & {
+        iconLeft?: React.ReactNode;
+        iconRight?: React.ReactNode;
+        openInNewTab?: boolean;
+        flex?: boolean;
+    }>;
+};

package/dist/src/core/linkBox/LinkBox.d.ts

@@ -0,0 +1,20 @@
+import React from 'react';
+export type LinkProps = Omit<React.ComponentPropsWithoutRef<'a'>, 'target'> & {
+    /**
+     * Link left icon component.
+     */
+    iconLeft?: React.ReactNode;
+    /**
+     * Link right icon component.
+     */
+    iconRight?: React.ReactNode;
+    /**
+     * Boolean indicating whether the link should be opened in a new tab.
+     */
+    openInNewTab?: boolean;
+    /**
+     * Boolean indicating whether flex attribute should be added to the container of the link.
+     */
+    flex?: boolean;
+};
+export declare function LinkBox({ children, flex, ...delegatedProps }: LinkProps): React.JSX.Element;

package/dist/src/core/navigation/Navigation.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+import type { Language, Menu } from '../../common/headlessService/types';
+type MenuItem = Omit<NonNullable<NonNullable<Menu>['menuItems']>['nodes'][0], '__typename'>;
+export type NavigationProps = {
+    menu?: Menu;
+    universalBarMenu?: Menu;
+    languages?: Language[];
+    className?: string;
+    userNavigation?: React.ReactNode;
+    onTitleClick: () => void;
+    getPathnameForLanguage: (language: Language, currentLanguage: Language, allLanguages: Language[]) => string;
+    getIsItemActive?: (menuItem: MenuItem) => boolean;
+};
+export declare function Navigation({ menu, universalBarMenu, languages, className, userNavigation, onTitleClick, getPathnameForLanguage, getIsItemActive, }: NavigationProps): React.JSX.Element;
+export {};

package/dist/src/core/notification/Notification.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import type { NotificationType } from '../../common/headlessService/types';
+export type NotificationProps = {
+    /**
+     * Notification object.
+     */
+    notification?: NotificationType | null;
+};
+export declare function Notification({ notification }: NotificationProps): false | React.JSX.Element;

package/dist/src/core/notification/__tests__/Notification.test.d.ts

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

package/dist/src/core/notification/utils/getIsNotificationActive.d.ts

@@ -0,0 +1,2 @@
+import type { NotificationType } from '../../../common/headlessService/types';
+export default function isNotificationActive(notification?: NotificationType | null): boolean;

package/dist/src/core/notification/utils/getNotificationHash.d.ts

@@ -0,0 +1,2 @@
+import type { NotificationType } from '../../../common/headlessService/types';
+export default function getNotificationHash(notification?: NotificationType | null): number;

package/dist/src/core/page/Page.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+export type PageProps = {
+    navigation: React.ReactNode;
+    notification?: React.ReactNode;
+    content: React.ReactNode;
+    footer: React.ReactNode;
+    className?: string;
+};
+export declare function Page({ navigation, notification, content, footer, className, }: PageProps): React.JSX.Element;

package/dist/src/core/page/Page.stories.d.ts

@@ -0,0 +1,40 @@
+import React from 'react';
+import { PageContent } from '../pageContent/PageContent';
+import { Navigation } from '../navigation/Navigation';
+import { Notification } from '../notification/Notification';
+import { Page } from './Page';
+import { Collection } from '../collection/Collection';
+declare const _default: {
+    title: string;
+    component: typeof Page;
+    subcomponents: {
+        PageContent: typeof PageContent;
+        Navigation: typeof Navigation;
+        Notification: typeof Notification;
+        Collection: typeof Collection;
+    };
+    argTypes: {
+        navigation: {
+            control: false;
+        };
+        notification: {
+            control: false;
+        };
+        content: {
+            control: false;
+        };
+        footer: {
+            control: false;
+        };
+    };
+};
+export default _default;
+export declare const PageDefault: {
+    render: import("storybook/internal/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("./Page").PageProps>;
+    args: {
+        navigation: React.JSX.Element;
+        notification: React.JSX.Element;
+        content: React.JSX.Element;
+        footer: React.JSX.Element;
+    };
+};

package/dist/src/core/pageContent/PageContent.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import type { PageContentProps } from './types';
+import type { ArticleType, PageType } from '../../common/headlessService/types';
+export declare const defaultContentModules: (page: PageType | ArticleType) => React.ReactNode[];
+export declare const defaultContent: (page: PageType | ArticleType, onArticlesSearch?: (tag: string) => void) => React.JSX.Element;
+export declare const defaultCollections: ({ page, isEventModulesEnabled, isVenueModulesEnabled, }: {
+    page: PageType | ArticleType;
+    isEventModulesEnabled: boolean;
+    isVenueModulesEnabled: boolean;
+}) => React.JSX.Element[];
+export declare function PageContent(props: PageContentProps): React.JSX.Element;