@prezly/theme-kit-intl 6.6.0

package/README.md

@@ -0,0 +1,70 @@
+# Translations for Prezly Themes
+
+![Version](https://img.shields.io/npm/v/@prezly/theme-kit-intl)
+![License](https://img.shields.io/npm/l/@prezly/theme-kit-intl)
+[![Crowdin](https://badges.crowdin.net/prezly-themes/localized.svg)](https://crowdin.com)
+
+This repo is a supplementary package for Prezly themes that need multi-language support.
+It has two main exports:
+- Translation files in ICU synthax compiled to work seamlessly with [react-intl] library and Crowdin.
+- Typed message descriptors to use in [react-intl] `FormattedMessage` components and `formatMessage` helpers.
+
+## Getting started
+
+
+
+### npm
+```Shell
+npm install react-intl @prezly/theme-kit-intl
+```
+
+### Usage in the application
+
+1) Import the messages for your desired locale. `localeIsoCode` refers to a ISO hyphen-code. You can check which locale codes are supported in the [theme-kit-nextjs](https://github.com/prezly/theme-kit-nextjs/blob/main/src/intl/locale.ts#L10-L57) repo.
+```ts
+const messages = await import(`@prezly/theme-kit-intl/messages/${localeIsoCode}.json`);
+```
+
+2) Pass the messages to the `IntlProvider` wrapper component. It should be at the top of your component tree to work properly.
+```tsx
+<IntlProvider
+    locale={localeIsoCode}
+    defaultLocale="en"
+    messages={messages}
+>
+  {/* Your application code */}
+</IntlProvider>
+```
+
+3) Use the message descriptor to render the message in your component. Your IDE should give hints on the messages structure.
+```tsx
+import { translations } from '@prezly/theme-kit-intl';
+import { FormattedMessage } from 'react-intl';
+
+function Component() {
+  return <FormattedMessage {...translations.actions.download} />
+}
+
+```
+
+You can check an example on how to import messages in a Next.js theme in the [Prezly Bea Theme repo](https://github.com/prezly/theme-nextjs-bea/blob/main/utils/lang.ts).
+
+### Message descriptors structure
+
+- `actions` -> Labels for buttons or links that trigger a specific action
+- `content` -> Mostly titles for various sections of a site that are related to the displayed content in some way
+- `errors` -> Messages for error pages (404/500) and form validation errors
+- `search` -> Messages related to the Search module
+- `subscription` -> Messages related to the Subscription module
+- `misc` -> Messages not suiting in any of the above categories
+
+---
+
+### Documentation on updating the translations (Prezly internal)
+The process of adding new translations to Prezly Themes is described in the [Notion article](https://www.notion.so/prezly/Themes-Translations-i18n-4ae8aa613db146168623dfc65d9e8359)
+
+----
+
+Brought to you by [Prezly](https://www.prezly.com/?utm_source=github&utm_campaign=@prezly/theme-kit-js/packages/intl).
+
+[react-intl]: https://formatjs.io/docs/react-intl

package/build/cjs/index.d.ts

@@ -0,0 +1,4 @@
+import * as translations from './messages/index.js';
+export { translations };
+export { isLocaleSupported } from './isLocaleSupported';
+export { locales as supportedLocales } from './locales';

package/build/cjs/index.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "isLocaleSupported", {
+  enumerable: true,
+  get: function get() {
+    return _isLocaleSupported.isLocaleSupported;
+  }
+});
+Object.defineProperty(exports, "supportedLocales", {
+  enumerable: true,
+  get: function get() {
+    return _locales.locales;
+  }
+});
+exports.translations = void 0;
+var translations = require("./messages/index.js");
+exports.translations = translations;
+var _isLocaleSupported = require("./isLocaleSupported");
+var _locales = require("./locales");

package/build/cjs/isLocaleSupported.d.ts

@@ -0,0 +1 @@
+export declare function isLocaleSupported(code: string): boolean;

package/build/cjs/isLocaleSupported.js

@@ -0,0 +1,7 @@
+"use strict";
+
+exports.isLocaleSupported = isLocaleSupported;
+var _locales = require("./locales");
+function isLocaleSupported(code) {
+  return _locales.locales.indexOf(code) >= 0;
+}

package/build/cjs/locales.d.ts

@@ -0,0 +1 @@
+export declare const locales: string[];

package/build/cjs/locales.js

@@ -0,0 +1,5 @@
+"use strict";
+
+exports.locales = void 0;
+// WARNING: This code is generated by build-locales.js. Please do not modify it directly (including formatting).
+var locales = exports.locales = ['af', 'ar', 'az', 'be', 'bg', 'ca', 'cs', 'da', 'de', 'el', 'en', 'es', 'et', 'fi', 'fil', 'fr', 'ga', 'he', 'hi', 'hr', 'hu', 'id', 'it', 'ja', 'kk', 'ko', 'lt', 'lv', 'mt', 'nl', 'no', 'pl', 'pt', 'pt-BR', 'ro', 'ru', 'sk', 'sl', 'sr', 'sv', 'sw', 'th', 'tr', 'uk', 'ur', 'uz', 'vi', 'zh-CN', 'zh-TW'];

package/build/cjs/messages/actions.d.ts

@@ -0,0 +1,58 @@
+export declare const actions: {
+    backToHomePage: {
+        id: string;
+        defaultMessage: string;
+    };
+    copyShareUrl: {
+        id: string;
+        defaultMessage: string;
+    };
+    download: {
+        id: string;
+        defaultMessage: string;
+    };
+    loadMore: {
+        id: string;
+        defaultMessage: string;
+    };
+    more: {
+        id: string;
+        defaultMessage: string;
+    };
+    privacyRequests: {
+        id: string;
+        defaultMessage: string;
+    };
+    readMore: {
+        id: string;
+        defaultMessage: string;
+    };
+    reload: {
+        id: string;
+        defaultMessage: string;
+    };
+    share: {
+        id: string;
+        defaultMessage: string;
+    };
+    startUsingCookies: {
+        id: string;
+        defaultMessage: string;
+    };
+    stopUsingCookies: {
+        id: string;
+        defaultMessage: string;
+    };
+    subscribe: {
+        id: string;
+        defaultMessage: string;
+    };
+    unsubscribe: {
+        id: string;
+        defaultMessage: string;
+    };
+    toggleFilters: {
+        id: string;
+        defaultMessage: string;
+    };
+};

package/build/cjs/messages/actions.js

@@ -0,0 +1,62 @@
+"use strict";
+
+exports.actions = void 0;
+var _intl = require("@formatjs/intl");
+var actions = exports.actions = (0, _intl.defineMessages)({
+  backToHomePage: {
+    id: 'actions.backToHomepage',
+    defaultMessage: 'Back to homepage'
+  },
+  copyShareUrl: {
+    id: 'actions.copyShareUrl',
+    defaultMessage: 'Copy URL'
+  },
+  download: {
+    id: 'actions.download',
+    defaultMessage: 'Download'
+  },
+  loadMore: {
+    id: 'actions.loadMore',
+    defaultMessage: 'Load more'
+  },
+  more: {
+    id: 'actions.more',
+    defaultMessage: 'More'
+  },
+  privacyRequests: {
+    id: 'actions.privacyRequests',
+    defaultMessage: 'Privacy requests'
+  },
+  readMore: {
+    id: 'actions.readMore',
+    defaultMessage: 'Read more'
+  },
+  reload: {
+    id: 'actions.reload',
+    defaultMessage: 'Reload'
+  },
+  share: {
+    id: 'actions.share',
+    defaultMessage: 'Share:'
+  },
+  startUsingCookies: {
+    id: 'actions.startUsingCookies',
+    defaultMessage: 'Start using cookies'
+  },
+  stopUsingCookies: {
+    id: 'actions.stopUsingCookies',
+    defaultMessage: 'Stop using cookies'
+  },
+  subscribe: {
+    id: 'actions.subscribe',
+    defaultMessage: 'Subscribe'
+  },
+  unsubscribe: {
+    id: 'actions.unsubscribe',
+    defaultMessage: 'Unsubscribe'
+  },
+  toggleFilters: {
+    id: 'actions.toggleFilters',
+    defaultMessage: 'Toggle search filters'
+  }
+});

package/build/cjs/messages/content.d.ts

@@ -0,0 +1,66 @@
+export declare const boilerplate: {
+    title: {
+        id: string;
+        defaultMessage: string;
+    };
+    contact: {
+        id: string;
+        defaultMessage: string;
+    };
+};
+export declare const categories: {
+    title: {
+        id: string;
+        defaultMessage: string;
+    };
+};
+export declare const contacts: {
+    title: {
+        id: string;
+        defaultMessage: string;
+    };
+};
+export declare const mediaGallery: {
+    title: {
+        id: string;
+        defaultMessage: string;
+    };
+};
+export declare const noStories: {
+    title: {
+        id: string;
+        defaultMessage: string;
+    };
+    subtitle: {
+        id: string;
+        defaultMessage: string;
+    };
+};
+export declare const newsroom: {
+    title: {
+        id: string;
+        defaultMessage: string;
+    };
+};
+export declare const cookieConsent: {
+    title: {
+        id: string;
+        defaultMessage: string;
+    };
+    description: {
+        id: string;
+        defaultMessage: string;
+    };
+    accept: {
+        id: string;
+        defaultMessage: string;
+    };
+    reject: {
+        id: string;
+        defaultMessage: string;
+    };
+    notice: {
+        id: string;
+        defaultMessage: string;
+    };
+};

package/build/cjs/messages/content.js

@@ -0,0 +1,70 @@
+"use strict";
+
+exports.noStories = exports.newsroom = exports.mediaGallery = exports.cookieConsent = exports.contacts = exports.categories = exports.boilerplate = void 0;
+var _intl = require("@formatjs/intl");
+var boilerplate = exports.boilerplate = (0, _intl.defineMessages)({
+  title: {
+    id: 'boilerplate.title',
+    defaultMessage: 'About {companyName}'
+  },
+  contact: {
+    id: 'boilerplate.contact',
+    defaultMessage: 'Contact'
+  }
+});
+var categories = exports.categories = (0, _intl.defineMessages)({
+  title: {
+    id: 'categories.title',
+    defaultMessage: 'Categories'
+  }
+});
+var contacts = exports.contacts = (0, _intl.defineMessages)({
+  title: {
+    id: 'contacts.title',
+    defaultMessage: 'Contact us'
+  }
+});
+var mediaGallery = exports.mediaGallery = (0, _intl.defineMessages)({
+  title: {
+    id: 'mediaGallery.title',
+    defaultMessage: 'Media galleries'
+  }
+});
+var noStories = exports.noStories = (0, _intl.defineMessages)({
+  title: {
+    id: 'noStories.title',
+    defaultMessage: 'Welcome to {newsroom}!'
+  },
+  subtitle: {
+    id: 'noStories.subtitle',
+    defaultMessage: 'Come back later to see new stories.'
+  }
+});
+var newsroom = exports.newsroom = (0, _intl.defineMessages)({
+  title: {
+    id: 'newsroom.title',
+    defaultMessage: 'Site'
+  }
+});
+var cookieConsent = exports.cookieConsent = (0, _intl.defineMessages)({
+  title: {
+    id: 'cookieConsent.title',
+    defaultMessage: 'We would like to use cookies'
+  },
+  description: {
+    id: 'cookieConsent.subtitle',
+    defaultMessage: 'We use cookies on our website. They help us get to know you a little and how you use our website. This helps us provide a more valuable and tailored experience for you and others.'
+  },
+  accept: {
+    id: 'cookieConsent.accept',
+    defaultMessage: 'Yes, you can use cookies'
+  },
+  reject: {
+    id: 'cookieConsent.reject',
+    defaultMessage: 'No, do not use cookies'
+  },
+  notice: {
+    id: 'cookieConsent.notice',
+    defaultMessage: 'You can revoke cookies at anytime at the bottom of the page.'
+  }
+});

package/build/cjs/messages/errors.d.ts

@@ -0,0 +1,34 @@
+export declare const errors: {
+    unknown: {
+        id: string;
+        defaultMessage: string;
+    };
+    fieldRequired: {
+        id: string;
+        defaultMessage: string;
+    };
+    emailInvalid: {
+        id: string;
+        defaultMessage: string;
+    };
+};
+export declare const notFound: {
+    title: {
+        id: string;
+        defaultMessage: string;
+    };
+    subtitle: {
+        id: string;
+        defaultMessage: string;
+    };
+};
+export declare const serverError: {
+    title: {
+        id: string;
+        defaultMessage: string;
+    };
+    subtitle: {
+        id: string;
+        defaultMessage: string;
+    };
+};

package/build/cjs/messages/errors.js

@@ -0,0 +1,38 @@
+"use strict";
+
+exports.serverError = exports.notFound = exports.errors = void 0;
+var _intl = require("@formatjs/intl");
+var errors = exports.errors = (0, _intl.defineMessages)({
+  unknown: {
+    id: 'errors.unknown',
+    defaultMessage: 'Something went wrong. Please try submitting the form again'
+  },
+  fieldRequired: {
+    id: 'errors.fieldRequired',
+    defaultMessage: 'This field is required'
+  },
+  emailInvalid: {
+    id: 'errors.emailInvalid',
+    defaultMessage: 'Introduce a valid email address'
+  }
+});
+var notFound = exports.notFound = (0, _intl.defineMessages)({
+  title: {
+    id: 'notFound.title',
+    defaultMessage: 'The page you’re looking for doesn’t exist...'
+  },
+  subtitle: {
+    id: 'notFound.subtitle',
+    defaultMessage: 'If you typed the URL yourself, check the spelling in the address bar.'
+  }
+});
+var serverError = exports.serverError = (0, _intl.defineMessages)({
+  title: {
+    id: 'serverError.title',
+    defaultMessage: 'Something went wrong...'
+  },
+  subtitle: {
+    id: 'serverError.subtitle',
+    defaultMessage: 'Try refreshing the page or coming back a bit later.'
+  }
+});

package/build/cjs/messages/index.d.ts

@@ -0,0 +1,6 @@
+export * from './actions';
+export * from './content';
+export * from './errors';
+export * from './misc';
+export * from './search';
+export * from './subscription';

package/build/cjs/messages/index.js

@@ -0,0 +1,68 @@
+"use strict";
+
+var _actions = require("./actions");
+Object.keys(_actions).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _actions[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _actions[key];
+    }
+  });
+});
+var _content = require("./content");
+Object.keys(_content).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _content[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _content[key];
+    }
+  });
+});
+var _errors = require("./errors");
+Object.keys(_errors).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _errors[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _errors[key];
+    }
+  });
+});
+var _misc = require("./misc");
+Object.keys(_misc).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _misc[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _misc[key];
+    }
+  });
+});
+var _search = require("./search");
+Object.keys(_search).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _search[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _search[key];
+    }
+  });
+});
+var _subscription = require("./subscription");
+Object.keys(_subscription).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _subscription[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _subscription[key];
+    }
+  });
+});

package/build/cjs/messages/misc.d.ts

@@ -0,0 +1,20 @@
+export declare const misc: {
+    embargoMessage: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    stateLoading: {
+        id: string;
+        defaultMessage: string;
+    };
+    shareUrlCopied: {
+        id: string;
+        defaultMessage: string;
+    };
+    toggleMobileNavigation: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};

package/build/cjs/messages/misc.js

@@ -0,0 +1,24 @@
+"use strict";
+
+exports.misc = void 0;
+var _intl = require("@formatjs/intl");
+var misc = exports.misc = (0, _intl.defineMessages)({
+  embargoMessage: {
+    id: 'misc.embargoMessage',
+    defaultMessage: 'Embargo until {date}',
+    description: 'Embargo means that the story is not allowed to be shared before the specified date'
+  },
+  stateLoading: {
+    id: 'misc.loading',
+    defaultMessage: 'Loading...'
+  },
+  shareUrlCopied: {
+    id: 'misc.shareUrlCopied',
+    defaultMessage: 'URL copied!'
+  },
+  toggleMobileNavigation: {
+    id: 'misc.toggleMobileNavigation',
+    defaultMessage: 'Toggle navigation',
+    description: 'A tooltip for a button that toggles the mobile menu on the web page'
+  }
+});

package/build/cjs/messages/search.d.ts

@@ -0,0 +1,66 @@
+export declare const search: {
+    title: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    action: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    filters: {
+        id: string;
+        defaultMessage: string;
+    };
+    inputLabel: {
+        id: string;
+        defaultMessage: string;
+    };
+    inputHint: {
+        id: string;
+        defaultMessage: string;
+    };
+    resultsTitle: {
+        id: string;
+        defaultMessage: string;
+    };
+    noResults: {
+        id: string;
+        defaultMessage: string;
+    };
+    showAllResults: {
+        id: string;
+        defaultMessage: string;
+    };
+    viewMore: {
+        id: string;
+        defaultMessage: string;
+    };
+    viewLess: {
+        id: string;
+        defaultMessage: string;
+    };
+    fullResultsTitle: {
+        id: string;
+        defaultMessage: string;
+    };
+    fullResultsSubTitle: {
+        id: string;
+        defaultMessage: string;
+    };
+};
+export declare const searchFacets: {
+    category: {
+        id: string;
+        defaultMessage: string;
+    };
+    year: {
+        id: string;
+        defaultMessage: string;
+    };
+    month: {
+        id: string;
+        defaultMessage: string;
+    };
+};