@sveltekit-i18n/base 1.0.0-beta.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 sveltekit-i18n
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,121 @@
+
+
+[![npm version](https://badge.fury.io/js/sveltekit-i18n%2Fbase.svg)](https://badge.fury.io/js/sveltekit-i18n%2Fbase) ![](https://github.com/sveltekit-i18n/base/workflows/Tests/badge.svg)
+
+# @sveltekit-i18n/base
+This repository contains the base functionality of [sveltekit-i18n](https://github.com/sveltekit-i18n/lib) and provides support for external message parsers.
+
+## Key features
+
+✅ SvelteKit ready\
+✅ SSR support\
+✅ Custom data sources – no matter if you are using local files or remote API to get your translations\
+✅ Module-based – your translations are loaded for visited pages only (and only once!)\
+✅ Component-scoped translations – you can create multiple instances with custom definitions\
+✅ Custom modifiers – you can modify the input data the way you really need\
+✅ TS support\
+✅ No external dependencies
+
+## Usage
+
+Setup `translations.js` in your lib folder...
+```javascript
+import i18n from '@sveltekit-i18n/base';
+import parser from '@sveltekit-i18n/parser-default'; // use your preferred parser (or create your own)
+
+/** @type {import('@sveltekit-i18n/base').Config} */
+export const config = ({
+  parser: parser(),
+  loaders: [
+    {
+      locale: 'en',
+      key: 'common',
+      loader: async () => (
+        await import('./en/common.json')
+      ).default,
+    },
+    {
+      locale: 'en',
+      key: 'home',
+      routes: ['/'], // you can use regexes as well!
+      loader: async () => (
+        await import('./en/home.json')
+      ).default,
+    },
+    {
+      locale: 'en',
+      key: 'about',
+      routes: ['/about'],
+      loader: async () => (
+        await import('./en/about.json')
+      ).default,
+    },
+    {
+      locale: 'cs',
+      key: 'common',
+      loader: async () => (
+        await import('./cs/common.json')
+      ).default,
+    },
+    {
+      locale: 'cs',
+      key: 'home',
+      routes: ['/'],
+      loader: async () => (
+        await import('./cs/home.json')
+      ).default,
+    },
+    {
+      locale: 'cs',
+      key: 'about',
+      routes: ['/about'],
+      loader: async () => (
+        await import('./cs/about.json')
+      ).default,
+    },
+  ],
+});
+
+export const { t, locale, locales, loading, loadTranslations } = new i18n(config);
+```
+
+...load your translations in `__layout.svelte`...
+
+```svelte
+<script context="module">
+  import { locale, loadTranslations } from '$lib/translations';
+
+  export const load = async ({ url }) => {
+    const { pathname } = url;
+
+    const defaultLocale = 'en'; // get from cookie, user session, ...
+    
+    const initLocale = locale.get() || defaultLocale; // set default if no locale already set
+
+    await loadTranslations(initLocale, pathname);
+
+    return {};
+  }
+</script>
+```
+
+...and include your translations within pages and components.
+
+```svelte
+<script>
+  import { t } from '$lib/translations';
+
+  const pageName = 'This page is Home page!';
+</script>
+
+<div>
+  <!-- you can use `placeholders` and `modifiers` in your definitions (see docs) -->
+  <h2>{$t('common.page', { pageName })}</h2>
+  <p>{$t('home.content')}</p>
+</div>
+```
+
+## More info
+[Docs](https://github.com/sveltekit-i18n/lib/tree/master/docs/README.md)\
+[Examples](https://github.com/sveltekit-i18n/lib/tree/master/examples)\
+[Changelog](https://github.com/sveltekit-i18n/lib/releases)

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@sveltekit-i18n/base",
+  "version": "1.0.0-beta.0",
+  "description": "Base functionality of sveltekit-i18n library with a support for external message parsers.",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "dev": "tsup src/index.ts --watch",
+    "test": "jest",
+    "build": "tsup src/index.ts --dts --format cjs,esm --minify",
+    "prepublishOnly": "rm -rf dist && npm run build",
+    "lint": "eslint --fix --ext .ts,.js --ignore-path .gitignore ."
+  },
+  "files": [
+    "lib",
+    "types"
+  ],
+  "pre-commit": [
+    "lint"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/sveltekit-i18n/base.git"
+  },
+  "keywords": [
+    "svelte",
+    "sveltekit",
+    "i18n",
+    "l10n",
+    "internationalization",
+    "localization",
+    "translation"
+  ],
+  "author": "Jarda Svoboda",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/sveltekit-i18n/lib/issues"
+  },
+  "homepage": "https://github.com/sveltekit-i18n/base#readme",
+  "peerDependencies": {
+    "svelte": "^3.44.3"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.0.3",
+    "@typescript-eslint/eslint-plugin": "^5.7.0",
+    "@typescript-eslint/parser": "^5.7.0",
+    "eslint": "^8.4.1",
+    "eslint-config-airbnb-typescript": "^16.1.0",
+    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-svelte3": "^3.2.1",
+    "jest": "^27.4.5",
+    "pre-commit": "^1.2.2",
+    "svelte": "^3.44.3",
+    "ts-jest": "^27.1.2",
+    "tsup": "^5.11.13",
+    "typescript": "^4.5.4"
+  }
+}

package/types/index.d.ts

@@ -0,0 +1,71 @@
+import { Readable, Writable } from 'svelte/store';
+
+type LoadingStore = Readable<boolean> & { toPromise: () => Promise<void[]>, get: () => boolean };
+
+type Loader = () => Promise<Record<any, any>>;
+
+type Route = string | RegExp;
+
+type LoaderModule = {
+  key: string;
+  locale: string;
+  routes?: Route[];
+  loader: Loader;
+};
+
+type TranslationFunction = (key: string, vars?: Record<any, any>) => string;
+
+type LocalTranslationFunction = (locale: string, key: string, vars?: Record<any, any>) => string;
+
+type ExtendedStore<T, Get = () => T, Store = Readable<T>> = Store & { get: Get };
+
+type ConfigTranslations = { [locale: string]: Record<string, any> };
+
+type Translations = { [locale: string]: Record<string, string> };
+
+type Config = {
+  parser: {
+    parse: (props: {
+      key: string;
+      payload: any;
+      translations: Translations;
+      locale: string;
+      fallbackLocale?: string;
+    }) => string;
+  };
+  loaders?: LoaderModule[];
+  translations?: ConfigTranslations;
+  initLocale?: string;
+  fallbackLocale?: string;
+};
+
+declare class export_default{
+    constructor(config?: Config);
+    private loadedKeys;
+    private currentRoute;
+    private config;
+    private isLoading;
+    private promises;
+    loading: LoadingStore;
+    private privateTranslations;
+    translations: ExtendedStore<Translations>;
+    locales: ExtendedStore<string[]>;
+    private internalLocale;
+    locale: ExtendedStore<string, () => string, Writable<string>>;
+    private loaderTrigger;
+    initialized: Readable<boolean>;
+    private translation;
+    t: ExtendedStore<TranslationFunction, TranslationFunction>;
+    l: ExtendedStore<LocalTranslationFunction, LocalTranslationFunction>;
+    private getLocale;
+    setLocale: (locale?: string | undefined) => Promise<void>;
+    setRoute: (route: string) => Promise<void>;
+    loadConfig: (config: Config) => Promise<void>;
+    addTranslations: (translations?: ConfigTranslations | undefined, keys?: Record<string, string[]> | undefined) => void;
+    getTranslationProps: ($locale?: string, $route?: string) => Promise<[ConfigTranslations, Record<string, string[]>] | [
+    ]>;
+    private translationLoader;
+    loadTranslations: (locale: string, route?: string) => Promise<void>;
+}
+
+export { Config, export_default as default };